instagram 0.11.0 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzdmODUyMDg3MTBkNjYzM2Q1MjY4YjBkOTUxNTcwN2FmOWMxZGNmMg==
+    MzgxZDBjNmRmOTY4Y2Q4NjI0YzE0NDc1NTQ2ZThmYzQ1ZDgxMzA2MA==
   data.tar.gz: !binary |-
-    OWFiZGIxNjU2MThhMjZmMmFiYzU5ZDk4MTQ5MTIyNTc4Nzc4YjE3Ng==
+    ZmM0YmZhNjVjYzVmMGE0NTVlMTQyMmNjNDk3ZDhlMTBiZjEyY2YzMw==
 SHA512:
   metadata.gz: !binary |-
-    MjAyNjQwNGYxNzEyYThiM2JjM2I0YjhkYjYyYjVhODczMzVkNjgxNzBhZDc5
-    ODYxOTYyYjk1YjQ2OGVjOTk2ZmIyNzg0N2ViMzJhYTVjMjQwMzAzNWMyOTZi
-    Yzg2ODg5NTZkNzM0NWFkZDAwNDJiMmIyYWRkNmM0ODFmMTYwOTQ=
+    NmIwZDYxY2NiZTM1ODhjZDRiMGQzODYzNDNhMzVjNWZhYjgwYjkwYTE0MjQy
+    YTVlYmFhMzNjMWQ3NzBiMjdmZWNjMTQwYzliY2Y0ZDA2NjRhZjhjMTI2OTQz
+    ZWI4MTY3MmQ3MTgzZTNjMGM4OWQ3YzMwZjE0YTllZTRjODJiMTE=
   data.tar.gz: !binary |-
-    NDM1Zjk4MGQ4MjBkMjQ3MmQyZDljN2Q5OTI4ZjQ0YTQ2NTc1NGMxYTc3MTVl
-    NjgzYWIzYjUwZDI2ODEwNDY0MzIwYWYwOWU5OTgyMjQ1Y2QwOWFhNTAzN2U2
-    NDcwMGYwMTFkYTUzNmEzNDAxM2FiMTFlMWI2MGI3OWQxY2VmZWM=
+    ZDk2Y2ZhZjNmNDM3ZDJjNDVmMGVlOGUzMjUwM2JiOGUyMDJhODhjNzFlZWRi
+    M2U0NTAzNmY1Y2E2ZTgyOGZhYmFhNzIyNDc5MzhhYjc1N2EyY2IxZmYzN2Qx
+    YTY0OTkyOWMyNmY0OGQ3MWZlNzVkNjIyOGMyNjJlZmViY2I3NDk=

data/.gitignore

@@ -3,6 +3,7 @@
 .DS_Store
 .bundle
 .rvmrc
+.ruby-version
 .yardoc
 .rake_tasks~
 Gemfile.lock

data/LICENSE.md

@@ -1,20 +1,30 @@
-Copyright (c) 2011 Instagram (Burbn, Inc.)
+BSD License
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+For Ruby Instagram Gem software
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Copyright (c) 2014, Facebook, Inc. All rights reserved.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+ * Neither the name Facebook nor the names of its contributors may be used to
+   endorse or promote products derived from this software without specific
+   prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/PATENTS.md

@@ -0,0 +1,23 @@
+Additional Grant of Patent Rights
+
+"Software" means the Instagram Ruby Gem software distributed by Facebook, Inc.
+
+Facebook hereby grants you a perpetual, worldwide, royalty-free, non-exclusive,
+irrevocable (subject to the termination provision below) license under any
+rights in any patent claims owned by Facebook, to make, have made, use, sell,
+offer to sell, import, and otherwise transfer the Software. For avoidance of
+doubt, no license is granted under Facebook’s rights in any patent claims that
+are infringed by (i) modifications to the Software made by you or a third party,
+or (ii) the Software in combination with any software or other technology
+provided by you or a third party.
+
+The license granted hereunder will terminate, automatically and without notice,
+for anyone that makes any claim (including by filing any lawsuit, assertion or
+other action) alleging (a) direct, indirect, or contributory infringement or
+inducement to infringe any patent: (i) by Facebook or any of its subsidiaries or
+affiliates, whether or not such claim is related to the Software, (ii) by any
+party if such claim arises in whole or in part from any software, product or
+service of Facebook or any of its subsidiaries or affiliates, whether or not
+such claim is related to the Software, or (iii) by any party relating to the
+Software; or (b) that any right in any patent claim of Facebook is invalid or
+unenforceable.

data/README.md

@@ -7,16 +7,19 @@ Installation
 ------------
 	gem install instagram
 
+Instagram REST and Search APIs
+------------------------------
+Our [developer site](http://instagram.com/developer) documents all the Instagram REST and Search APIs.
 
-Follow @instagramapi on Twitter
+
+Blog
 ----------------------------
-You should [follow @instagramapi on Twitter](http://twitter.com/#!/instagramapi) for announcements,
-updates, and news about the Instagram gem.
+The [Developer Blog] features news and important announcements about the Instagram Platform. You will also find tutorials and best practices to help you build great platform integrations. Make sure to subscribe to the RSS feed not to miss out on new posts: [http://developers.instagram.com](http://developers.instagram.com).
 
 
-Join the mailing list!
+Community
 ----------------------
-<https://groups.google.com/group/instagram-ruby-gem>
+The [Stack Overflow community](http://stackoverflow.com/questions/tagged/instagram/) is a great place to ask API related questions or if you need help with your code. Make sure to tag your questions with the Instagram tag to get fast answers from other fellow developers and members of the Instagram team.
 
 
 Does your project or organization use this gem?
@@ -36,8 +39,8 @@ enable :sessions
 CALLBACK_URL = "http://localhost:4567/oauth/callback"
 
 Instagram.configure do |config|
-  config.client_id = "YOUR_CLIENT_ID"
-  config.client_secret = "YOUR_CLIENT_SECRET"
+  config.client_id = "YOUR_CLIENT_ID" #"86893d683a2145fda781f77e48b9aa4a"
+  config.client_secret = "YOUR_CLIENT_SECRET" #"6fea5cbc10214966b131c43563fd4664"
 end
 
 get "/" do
@@ -51,65 +54,132 @@ end
 get "/oauth/callback" do
   response = Instagram.get_access_token(params[:code], :redirect_uri => CALLBACK_URL)
   session[:access_token] = response.access_token
-  redirect "/feed"
+  redirect "/nav"
+end
+
+get "/nav" do
+  html =
+  """
+    <h1>Ruby Instagram Gem Sample Application</h1>
+    <ol>
+      <li><a href='/user_recent_media'>User Recent Media</a> Calls user_recent_media - Get a list of a user's most recent media</li>
+      <li><a href='/user_media_feed'>User Media Feed</a> Calls user_media_feed - Get the currently authenticated user's media feed uses pagination</li>
+      <li><a href='/location_recent_media'>Location Recent Media</a> Calls location_recent_media - Get a list of recent media at a given location, in this case, the Instagram office</li>
+      <li><a href='/media_search'>Media Search</a> Calls media_search - Get a list of media close to a given latitude and longitude</li>
+      <li><a href='/media_popular'>Popular Media</a> Calls media_popular - Get a list of the overall most popular media items</li>
+      <li><a href='/user_search'>User Search</a> Calls user_search - Search for users on instagram, by name or username</li>
+      <li><a href='/location_search'>Location Search</a> Calls location_search - Search for a location by lat/lng</li>
+      <li><a href='/location_search_4square'>Location Search - 4Square</a> Calls location_search - Search for a location by Fousquare ID (v2)</li>
+      <li><a href='/tags'>Tags</a>Search for tags, view tag info and get media by tag</li>
+      <li><a href='/limits'>View Rate Limit and Remaining API calls</a>View remaining and ratelimit info.</li>
+    </ol>
+  """
+  html
 end
 
-get "/feed" do
+get "/user_recent_media" do
   client = Instagram.client(:access_token => session[:access_token])
   user = client.user
-
-  html = "<h1>#{user.username}'s recent photos</h1>"
+  html = "<h1>#{user.username}'s recent media</h1>"
   for media_item in client.user_recent_media
     html << "<img src='#{media_item.images.thumbnail.url}'>"
   end
   html
 end
-```
 
-API Usage Examples
-------------------
-```ruby
-require "rubygems"
-require "instagram"
-
-# All methods require authentication (either by client ID or access token).
-# To get your Instagram OAuth credentials, register an app at http://instagr.am/oauth/client/register/
-Instagram.configure do |config|
-  config.client_id = YOUR_CLIENT_KEY
-  config.access_token = YOUR_ACCESS_TOKEN
+get "/user_media_feed" do
+  client = Instagram.client(:access_token => session[:access_token])
+  user = client.user
+  html = "<h1>#{user.username}'s media feed</h1>"
+  
+  page_1 = client.user_media_feed(777)
+  page_2_max_id = page_1.pagination.next_max_id
+  page_2 = client.user_recent_media(777, :max_id => page_2_max_id ) unless page_2_max_id.nil?
+  html << "<h2>Page 1</h2><br/>"
+  for media_item in page_1
+    html << "<img src='#{media_item.images.thumbnail.url}'>"
+  end
+  html << "<h2>Page 2</h2><br/>"
+  for media_item in page_2
+    html << "<img src='#{media_item.images.thumbnail.url}'>"
+  end
+  html
 end
 
-# Get a list of a user's most recent media
-puts Instagram.user_recent_media(777)
+get "/location_recent_media" do
+  client = Instagram.client(:access_token => session[:access_token])
+  html = "<h1>Media from the Instagram Office</h1>"
+  for media_item in client.location_recent_media(514276)
+    html << "<img src='#{media_item.images.thumbnail.url}'>"
+  end
+  html
+end
 
-# Use pagination data from a response to get the next page
-page_1 = Instagram.user_recent_media(777)
-page_2_max_id = page_1.pagination.next_max_id
-page_2 = Instagram.user_recent_media(777, :max_id => page_2_max_id ) unless page_2_max_id.nil?
+get "/media_search" do
+  client = Instagram.client(:access_token => session[:access_token])
+  html = "<h1>Get a list of media close to a given latitude and longitude</h1>"
+  for media_item in client.media_search("37.7808851","-122.3948632")
+    html << "<img src='#{media_item.images.thumbnail.url}'>"
+  end
+  html
+end
 
-# Get the currently authenticated user's media feed
-puts Instagram.user_media_feed
+get "/media_popular" do
+  client = Instagram.client(:access_token => session[:access_token])
+  html = "<h1>Get a list of the overall most popular media items</h1>"
+  for media_item in client.media_popular
+    html << "<img src='#{media_item.images.thumbnail.url}'>"
+  end
+  html
+end
 
-# Get a list of recent media at a given location, in this case, the Instagram office
-puts Instagram.location_recent_media(514276)
+get "/user_search" do
+  client = Instagram.client(:access_token => session[:access_token])
+  html = "<h1>Search for users on instagram, by name or usernames</h1>"
+  for user in client.user_search("instagram")
+    html << "<li> <img src='#{user.profile_picture}'> #{user.username} #{user.full_name}</li>"
+  end
+  html
+end
 
-# Get a list of media close to a given latitude and longitude
-puts Instagram.media_search("37.7808851","-122.3948632")
+get "/location_search" do
+  client = Instagram.client(:access_token => session[:access_token])
+  html = "<h1>Search for a location by lat/lng with a radius of 5000m</h1>"
+  for location in client.location_search("48.858844","2.294351","5000")
+    html << "<li> #{location.name} <a href='https://www.google.com/maps/preview/@#{location.latitude},#{location.longitude},19z'>Map</a></li>"
+  end
+  html
+end
 
-# Get a list of the overall most popular media items
-puts Instagram.media_popular
+get "/location_search_4square" do
+  client = Instagram.client(:access_token => session[:access_token])
+  html = "<h1>Search for a location by Fousquare ID (v2)</h1>"
+  for location in client.location_search("3fd66200f964a520c5f11ee3")
+    html << "<li> #{location.name} <a href='https://www.google.com/maps/preview/@#{location.latitude},#{location.longitude},19z'>Map</a></li>"
+  end
+  html
+end
 
-# Search for users on instagram, by name or username
-puts Instagram.user_search("shayne sweeney")
+get "/tags" do
+  client = Instagram.client(:access_token => session[:access_token])
+  html = "<h1>Search for tags, get tag info and get media by tag</h1>"
+  tags = client.tag_search('cat')
+  html << "<h2>Tag Name = #{tags[0].name}. Media Count =  #{tags[0].media_count}. </h2><br/><br/>"
+  for media_item in client.tag_recent_media(tags[0].name)
+    html << "<img src='#{media_item.images.thumbnail.url}'>"
+  end
+  html
+end
 
-# Search for a location by lat/lng
-puts Instagram.location_search("37.7808851","-122.3948632")
+get "/limits" do
+  client = Instagram.client(:access_token => session[:access_token])
+  html = "<h1/>View API Rate Limit and calls remaining</h1>"
+  response = client.utils_raw_response
+  html << "Rate Limit = #{response.headers[:x_ratelimit_limit]}.  <br/>Calls Remaining = #{response.headers[:x_ratelimit_remaining]}"
 
-# Search for a location by Fousquare ID (v2)
-puts Instagram.location_search("3fd66200f964a520c5f11ee3")
+  html
+end
 ```
-	
-
 
 Contributing
 ------------
@@ -137,6 +207,10 @@ bug report, please include a [Gist](http://gist.github.com/) that includes a sta
 details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
 operating system. Ideally, a bug report should include a pull request with failing specs.
 
+Instagram has a [bounty program](https://www.facebook.com/whitehat/) for the safe
+disclosure of security bugs. In those cases, please go through the process
+outlined on that page and do not file a public issue.
+
 
 Submitting a Pull Request
 -------------------------
@@ -149,9 +223,18 @@ Submitting a Pull Request
 7. Run <tt>rake spec</tt>. If your changes are not 100% covered, go back to step 6.
 8. Commit and push your changes.
 9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+10. If you haven't already, complete the Contributor License Agreement ("CLA").
+
+Contributor License Agreement ("CLA")
+_____________________________________
+In order to accept your pull request, we need you to submit a CLA. You only need
+to do this once to work on any of Instagram's or Facebook's open source projects.
+
+Complete your CLA here: [https://code.facebook.com/cla](https://code.facebook.com/cla)
 
 
 Copyright
 ---------
-Copyright (c) 2011 Instagram (Burbn, Inc).
+Copyright (c) 2014, Facebook, Inc. All rights reserved.
+By contributing to Instgram Ruby Gem, you agree that your contributions will be licensed under its BSD license.
 See [LICENSE](https://github.com/Instagram/instagram-ruby-gem/blob/master/LICENSE.md) for details.

data/instagram.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rspec', '~> 2.4')
   s.add_development_dependency('webmock', '~> 1.6')
   s.add_development_dependency('bluecloth', '~> 2.0.11')
-  s.add_runtime_dependency('faraday', ['>= 0.7', '< 0.9'])
-  s.add_runtime_dependency('faraday_middleware', '~> 0.8')
+  s.add_runtime_dependency('faraday', ['>= 0.7', '< 0.10'])
+  s.add_runtime_dependency('faraday_middleware', ['>= 0.8', '< 0.10'])
   s.add_runtime_dependency('multi_json', '>= 1.0.3', '~> 1.0')
   s.add_runtime_dependency('hashie',  '>= 0.4.0')
   s.authors = ["Shayne Sweeney"]
@@ -14,11 +14,23 @@ Gem::Specification.new do |s|
   s.post_install_message =<<eos
 ********************************************************************************
 
-  Follow @instagramapi on Twitter for announcements, updates, and news.
-  https://twitter.com/instagramapi
+Instagram REST and Search APIs
+------------------------------
+Our developer site documents all the Instagram REST and Search APIs.
+(http://instagram.com/developer)
 
-  Join the mailing list!
-  https://groups.google.com/group/instagram-ruby-gem
+Blog
+----------------------------
+The Developer Blog features news and important announcements about the Instagram Platform. 
+You will also find tutorials and best practices to help you build great platform integrations.
+Make sure to subscribe to the RSS feed so you don't miss out on new posts: 
+(http://developers.instagram.com).
+
+Community
+----------------------
+The Stack Overflow community is a great place to ask API related questions or if you need help with your code.
+Make sure to tag your questions with the Instagram tag to get fast answers from other fellow developers and members of the Instagram team.
+(http://stackoverflow.com/questions/tagged/instagram/)
 
 ********************************************************************************
 eos

data/lib/faraday/raise_http_exception.rb

@@ -13,8 +13,12 @@ module FaradayMiddleware
           raise Instagram::NotFound, error_message_400(response)
         when 500
           raise Instagram::InternalServerError, error_message_500(response, "Something is technically wrong.")
+        when 502
+          raise Instagram::BadGateway, error_message_500(response, "The server returned an invalid or incomplete response.")
         when 503
           raise Instagram::ServiceUnavailable, error_message_500(response, "Instagram is rate limiting your requests.")
+        when 504
+          raise Instagram::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
         end
       end
     end

data/lib/instagram/api.rb

@@ -16,6 +16,14 @@ module Instagram
       end
     end
 
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
     include Connection
     include Request
     include OAuth

data/lib/instagram/client.rb

@@ -1,8 +1,8 @@
 module Instagram
   # Wrapper for the Instagram REST API
   #
-  # @note All methods have been separated into modules and follow the same grouping used in {TODO:doc_URL the Instagram API Documentation}.
-  # @see TODO:doc_url
+  # @note All methods have been separated into modules and follow the same grouping used in http://instagram.com/developer/
+  # @see http://instagram.com/developer/
   class Client < API
     Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
 

data/lib/instagram/client/comments.rb

@@ -14,7 +14,7 @@ module Instagram
       #
       #   If getting this data of a protected user, you must be authenticated (and be allowed to see that user).
       # @rate_limited true
-      # @see TODO:docs url
+      # @see http://instagram.com/developer/endpoints/comments/#get_media_comments
       def media_comments(id, *args)
         response = get("media/#{id}/comments")
         response
@@ -33,7 +33,7 @@ module Instagram
       #
       #   If getting this data of a protected user, you must be authenticated (and be allowed to see that user).
       # @rate_limited true
-      # @see TODO:docs url
+      # @see http://instagram.com/developer/endpoints/comments/#post_media_comments
       def create_media_comment(id, text, options={})
         response = post("media/#{id}/comments", options.merge(:text => text))
         response
@@ -52,7 +52,7 @@ module Instagram
       #
       #   In order to remove a comment, you must be the owner of the comment, the media item, or both.
       # @rate_limited true
-      # @see TODO:docs url
+      # @see http://instagram.com/developer/endpoints/comments/#delete_media_comments
       def delete_media_comment(media_id, comment_id, options={})
         response = delete("media/#{media_id}/comments/#{comment_id}", options)
         response