Skip to main content

How to pass a Rails or Sinatra variable into JQuery.

A few days back I got a code challenge for a cool job position. For whatever reason the test was very light on Rails very heavy on JQuery, which I didn't know much about frankly. So in less than 24 hours I had to not only learn enough of it but also make it work into a modal window widget. I got it done, but it wasn't elegant at all. I clobbered it even if it worked.

The first challenge was to get information into webpage from a Rails application, I chose JSON and thought it'd be easy-peasy, but transferring a JSON object is a cross-domain script violation and most browsers won't let it pass. So I learned about JSONp which wraps the JSON object in a JQuery call-back. Lacking the easy Ruby ways of determining what things are, at first I'd no idea what the JSONP object was and just had my Rails app send JSON. Once I figured what it was, it was trivial to get Rails to do it. All I had to do was add: :callback => params[:callback] to the format property in the controller action. A JSONP basically sends a JS object to the server, and then gets it back with your nifty little JSON object inside of it. Because it's the object you sent that comes back, it provides some security as it's not just any input that can come on in.

The real challenge was in learning JQuery which is has a completely different documentation from Ruby and one that's less readable, I think. I wrote it in CoffeeScript which I prefer, but that is no shortcut for learning the JQuery functions. On key thing to know, that doesn't seem obvious at all is that an Object's properties can't call a function, they can *be* a function that calls a function, but not call a function. So open : myfunc() doesn't work but open : -> myfunc() works perfectly fine.

So after (why is it always after) I submitted the code challenge, I found out that there is a JQuery UI that has a very pretty way of doing what I was trying to do. But now with my new found JQuery and Javascript know-how I was able to put it to go work and redid the widget using JQuery UI.

But, I wanted to make it better. I wanted the Sinatra Application hosting the JQuery widget to intelligently pass the url to the JQuery widget. And that's not as simple as it sounds, but it turns out there is a great gem that does exactly that and it's called gon and gon-sinatra.

For the Sinatra app all I needed was two lines:

require 'gon-sinatra' 
Sinatra::register Gon::Sinatra
and now I can set an instance variable to a gon method and then access it as a gon property on the JavaScript side.

Sinatra or erb view:
  gon.jsonp_url = @jsonp_url
CoffeeScript:
  $.ajax
    url: gon.jsonp_url


And voilá, now I can set the URL to get the JSON from different websites, maybe localhost in development and somewhere else in production. I'll put the code for the revised widget up on github soon.





Comments

Popular posts from this blog

What Medieval Economics can teach us about tariffs.

As a teen, I used to play Dungeons and Dragons (D&D) with my friends. This started an interest in the medieval period that led to me taking a medieval history class in college just to understand the period more. Over the years I've also read great books like " Dungeon, Fire and Sword " about the crusades (I recommend the book) and yet with all that knowledge it wasn't until recently that it occurred to me I had a completely wrong understanding of economics in the Medieval Period. "Viking helmets, sword and footwear" by eltpics is licensed under CC BY-NC 2.0 In my D&D games, players who are adventures battling monsters and creatures would need equipment and on the trips to town, they'd get resupplied with their adventuring necessities. I'd run these moments referencing my imagination of what it must have been and fantasy books I'd read. There be an inn with a raucous bar, a gruffly black-smith, if a city also a weapon and armor sm...

Great iPhone Apps

As a companion to my blog on Windows utilities, here are two paid apps on the iPhone that I consider so fantastic that are must buys in my opinion. -Easy Calendar ( $1.99 ) The iPhone Calendar is one of its weakest features in my opinion. I miss the clear Black Berry calendar on my pearl whenever I had to use it. This app makes the calendar not only easy to use but way more useful, I see my week laid out for me with an easy ability to push things to other days (rather than having to re-enter the appointment). This app has completely re-made the way I organize things. I'm way more organized and rarely miss appointment now. This app is a steal at it's prize. No other app adds such simple functionality to the iPhone like this one does. It's like my secret organizer helper. -Sleep Cycle ( $.99 ) I tried out this app because it was recommended on Tim Ferriss's books . I had seen this app before when it came out and thought it was intriguing, but it was way expensive. N...

Testing with Cucumber, Sinatra and Capybara

Everything you need to know There are many elements you need to simultaneously learn to do effective testing of your code. Because some of these elements are very simple a lot of explanations just jump over what you need to know and give them up as obvious. Let’s start with a list of the things you need to learn: Gherkin (the language of Cucumber) ——> super easy Capybara (the DSL that controls the browser tests) Rspec (the DSL in which the actual pass/fail tests are written.) None of these are hard. But having to learn all at the same time can seem daunting. But it’s not! It’s easy peasy but takes time. :-/ It took me three days to get a handle on this. And I hope by reading this you’ll get a handle on it much much quicker. Let’s start with Cucumber first. Cucumber Five things you need to know about Cucumber: Cucumber tests are located on a features folder that have plain text files with a .feature extension and written in Gherkin . The .feature files contain t...