instagram_api 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02de8a37a870ba8d1f221d49ee533744ac624cf6
-  data.tar.gz: d1e0de12dbb95d30e22c6ef52ff3bf3eb660f1a4
+  metadata.gz: 9f7698eefcd07fb266f0fc98566f9c8b8075cb51
+  data.tar.gz: 01490aa9e40ddcd9f32a7199ad630833576d97d2
 SHA512:
-  metadata.gz: 75b3721ddc83912c9c1df69e8c1c1610211cdef5b0fe26ea31fea5ff5aae86d5b251ed0120e71e4c5bdb2a581776a4d31de056cebf6d5c641c837c40bf362462
-  data.tar.gz: 320fd03ce080700e9646709d2f348d7820dc876850d71d0610b627b2a0889bb86ffc9e8c60c97a7f96d97484d9d29c7000ceac6ead2dd8d7fb975ab9a65ac814
+  metadata.gz: 9b0ff3479a4d3c62edaf90be64569ae6f9f60d89cfd069a7181860656063cee9f323b984b0e7f33404ea57b2d5c7738467fec3df2289b2db3a9e7ebd59438927
+  data.tar.gz: 14dc82eb57ea8aa012efb579d485a4c4b7d6a75c37cf9817f78b41a08a5c2dc63b2c69bd67067bcdd5f540d67a6570f14d5435720129e4bfabddfe672c3f4fa0

data/.gitignore

@@ -16,4 +16,5 @@ test/tmp
 test/version_tmp
 tmp
 versions/
-spec/config.yml
+spec/config.yml
+examples/

data/README.md

@@ -2,6 +2,10 @@
 
 This gem is a simple and easy to use wrapper for Instagram's API.
 
+## Documentation
+
+The documentation for this gem can be found at [rdoc.info/gems/instagram_api](http://rdoc.info/gems/instagram_api).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -108,6 +112,73 @@ client.popular_media
 
 See the [Instagram Media Endpoints](http://instagram.com/developer/endpoints/media/) for more information.
 
+## Sample Application
+
+The following is a sample application using this gem and [Sinatra](http://sinatrarb.com). Make sure that the sinatra and instagram_api gems are installed before running it.
+
+```bash
+$ gem install sinatra instagram_api
+```
+
+Afterwards, copy the contents of the following file into a file called sample.rb and add your client ID and client secret (retrieved by registering a new application at [http://instagram.com/developer](http://instagram.com/developer)).
+
+```ruby
+require 'sinatra'
+require 'instagram_api'
+
+# Go to http://instagram.com/developer to get your client ID and client secret.
+CLIENT_ID = "YOUR CLIENT ID"
+CLIENT_SECRET = "YOUR CLIENT SECRET"
+
+# Set the redirect uri for your application to the following:
+REDIRECT_URI = "http://localhost:4567/callback"
+
+client = Instagram.client(
+  :client_id => CLIENT_ID,
+  :client_secret => CLIENT_SECRET,
+  :callback_url => REDIRECT_URI
+)
+
+get '/' do
+  output = '<h2>Popular Media</h2>'
+  client.popular_media.data.each do |p|
+    output << "<a href='#{p.link}'><img src='#{p.images.thumbnail.url}'></a>&nbsp;"
+  end
+  output << '<br /><h3><a href="/auth">Click here</a> to authenticate with Instagram.</h3>'
+  output
+end
+
+get '/auth' do
+  redirect client.authorize_url
+end
+
+get '/callback' do
+  client.get_access_token(params[:code])
+  redirect '/dashboard'
+end
+
+get '/dashboard' do
+  user = client.user
+  output = "<h2>#{user.data.username}'s feed</h2>"
+  client.feed.data.each do |f|
+    output << "<a href='#{f.link}'><img src='#{f.images.low_resolution.url}'></a><br />
+    <img src='#{f.user.profile_picture}' width='20'>&nbsp;#{f.user.username}<br /><br />"
+  end
+  output
+end
+```
+
+You can then run the application by issuing the following command from the file's directory:
+
+```bash
+$ ruby sample.rb
+```
+
+Then navigate to [localhost:4567](http://localhost:4567) to see the application in action.
+
+You can view/download this file [here](https://gist.github.com/caseyscarborough/6331272).
+
+
 ## Contributing
 
 1. Fork it

data/lib/instagram_api/client/media.rb

@@ -28,10 +28,15 @@ module Instagram
       # @see http://instagram.com/developer/endpoints/media/#get_media_search
       # @example Perform a search based on latitude and longitude.
       #   client.media_search(:lat => "48.858844", :lng => "2.294351")
-      # @example Search within 2km.
-      #   client.media_search(:distance => 2000)
-      # @example Search by timestamp.
-      #   client.media_search(:min_timestamp => 1357020000, :max_timestamp => 1375246800)
+      # @example Search within 2km of a location.
+      #   client.media_search(:lat => "48.858844", :lng => "2.294351", :distance => 2000)
+      # @example Constrain results by timestamp.
+      #   client.media_search(
+      #     :lat => "48.858844",
+      #     :lng => "2.294351",
+      #     :min_timestamp => 1357020000,
+      #     :max_timestamp => 1375246800
+      #   )
       def media_search(options={})
         get '/media/search', auth_params.merge(options)
       end

data/lib/instagram_api/version.rb

@@ -1,3 +1,3 @@
 module Instagram
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: instagram_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Casey Scarborough