instagram 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzgxZDBjNmRmOTY4Y2Q4NjI0YzE0NDc1NTQ2ZThmYzQ1ZDgxMzA2MA==
+    OGU4OWZjOWU2YjA2Yzg2ZTU5OGMzZTEyMDcxZWM5OTU2NTI5Yzk1Nw==
   data.tar.gz: !binary |-
-    ZmM0YmZhNjVjYzVmMGE0NTVlMTQyMmNjNDk3ZDhlMTBiZjEyY2YzMw==
+    NDY2NjdiZjM2YmJiODE1MjllYmMxMTdiZGU2ZmVjMjA3MzM5NDFiNg==
 SHA512:
   metadata.gz: !binary |-
-    NmIwZDYxY2NiZTM1ODhjZDRiMGQzODYzNDNhMzVjNWZhYjgwYjkwYTE0MjQy
-    YTVlYmFhMzNjMWQ3NzBiMjdmZWNjMTQwYzliY2Y0ZDA2NjRhZjhjMTI2OTQz
-    ZWI4MTY3MmQ3MTgzZTNjMGM4OWQ3YzMwZjE0YTllZTRjODJiMTE=
+    MmMwNDBiNGFlZmMwODg4ZjNlNzQ5NmIwNmYyOGFkMzBlOWJlYjIzYmVjN2Zk
+    YWY2OTY2OTVkOWQyMDBmYjMzMDhmZGMxYWZmMmFiZWE0ZmNmNDJlZmRlNWRl
+    ZDJmMTdkZTc1Y2E3MWU1NWI1NzMwZGJkOWI2ZmRiOWE5MGFhZjA=
   data.tar.gz: !binary |-
-    ZDk2Y2ZhZjNmNDM3ZDJjNDVmMGVlOGUzMjUwM2JiOGUyMDJhODhjNzFlZWRi
-    M2U0NTAzNmY1Y2E2ZTgyOGZhYmFhNzIyNDc5MzhhYjc1N2EyY2IxZmYzN2Qx
-    YTY0OTkyOWMyNmY0OGQ3MWZlNzVkNjIyOGMyNjJlZmViY2I3NDk=
+    OTVjOTBlMjMyYmMyMzRmYTk3MGJjMTdjNDM0YmJlMmMxNzhiNzUwNjc1ZDA3
+    MzJjODgyNmQzZGM2MDExMGQ0ODIyMTQ0ZWIzYzIzMTEwNDkwOTk4MmRhYjg3
+    YTQyYTJmMThkZTk1NTY1ZDY3MjA3OGE1NTI5NTkwZjBkOWFlYzQ=

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.0.0
+  - 1.9.3

data/README.md

@@ -39,8 +39,10 @@ enable :sessions
 CALLBACK_URL = "http://localhost:4567/oauth/callback"
 
 Instagram.configure do |config|
-  config.client_id = "YOUR_CLIENT_ID" #"86893d683a2145fda781f77e48b9aa4a"
-  config.client_secret = "YOUR_CLIENT_SECRET" #"6fea5cbc10214966b131c43563fd4664"
+  config.client_id = "YOUR_CLIENT_ID"
+  config.client_secret = "YOUR_CLIENT_SECRET"
+  # For secured endpoints only
+  #config.client_ips = '<Comma separated list of IPs>'
 end
 
 get "/" do
@@ -82,11 +84,23 @@ get "/user_recent_media" do
   user = client.user
   html = "<h1>#{user.username}'s recent media</h1>"
   for media_item in client.user_recent_media
-    html << "<img src='#{media_item.images.thumbnail.url}'>"
+    html << "<div style='float:left;'><img src='#{media_item.images.thumbnail.url}'><br/> <a href='/media_like/#{media_item.id}'>Like</a>  <a href='/media_unlike/#{media_item.id}'>Un-Like</a>  <br/>LikesCount=#{media_item.likes[:count]}</div>"
   end
   html
 end
 
+get '/media_like/:id' do
+  client = Instagram.client(:access_token => session[:access_token])
+  client.like_media("#{params[:id]}")
+  redirect "/user_recent_media"
+end
+
+get '/media_unlike/:id' do
+  client = Instagram.client(:access_token => session[:access_token])
+  client.unlike_media("#{params[:id]}")
+  redirect "/user_recent_media"
+end
+
 get "/user_media_feed" do
   client = Instagram.client(:access_token => session[:access_token])
   user = client.user

data/instagram.gemspec

@@ -2,6 +2,7 @@
 require File.expand_path('../lib/instagram/version', __FILE__)
 
 Gem::Specification.new do |s|
+  s.add_development_dependency('rake', '~> 0.9.2.2')
   s.add_development_dependency('rspec', '~> 2.4')
   s.add_development_dependency('webmock', '~> 1.6')
   s.add_development_dependency('bluecloth', '~> 2.0.11')
@@ -21,9 +22,9 @@ Our developer site documents all the Instagram REST and Search APIs.
 
 Blog
 ----------------------------
-The Developer Blog features news and important announcements about the Instagram Platform. 
+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: 
+Make sure to subscribe to the RSS feed so you don't miss out on new posts:
 (http://developers.instagram.com).
 
 Community

data/lib/faraday/raise_http_exception.rb

@@ -11,6 +11,8 @@ module FaradayMiddleware
           raise Instagram::BadRequest, error_message_400(response)
         when 404
           raise Instagram::NotFound, error_message_400(response)
+        when 429
+          raise Instagram::TooManyRequests, error_message_400(response)
         when 500
           raise Instagram::InternalServerError, error_message_500(response, "Something is technically wrong.")
         when 502
@@ -45,6 +47,8 @@ module FaradayMiddleware
         nil
       elsif body['meta'] and body['meta']['error_message'] and not body['meta']['error_message'].empty?
         ": #{body['meta']['error_message']}"
+      elsif body['error_message'] and not body['error_message'].empty?
+        ": #{body['error_type']}: #{body['error_message']}"
       end
     end
 

data/lib/instagram/client/comments.rb

@@ -35,7 +35,7 @@ module Instagram
       # @rate_limited true
       # @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 = post("media/#{id}/comments", options.merge(:text => text), signature=true)
         response
       end
 
@@ -54,7 +54,7 @@ module Instagram
       # @rate_limited true
       # @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 = delete("media/#{media_id}/comments/#{comment_id}", options, signature=true)
         response
       end
     end

data/lib/instagram/client/embedding.rb

@@ -21,7 +21,7 @@ module Instagram
       def oembed(*args)
         url = args.first
         return nil unless url
-        get("oembed?url=#{url}", {}, false, true)
+        get("oembed?url=#{url}", {}, false, false, true)
       end
     end
   end

data/lib/instagram/client/likes.rb

@@ -34,7 +34,7 @@ module Instagram
       # @rate_limited true
       # @see http://instagram.com/developer/endpoints/likes/#post_likes
       def like_media(id, options={})
-        response = post("media/#{id}/likes", options)
+        response = post("media/#{id}/likes", options, signature=true)
         response
       end
 
@@ -50,7 +50,7 @@ module Instagram
       # @rate_limited true
       # @see http://instagram.com/developer/endpoints/likes/#delete_likes
       def unlike_media(id, options={})
-        response = delete("media/#{id}/likes", options)
+        response = delete("media/#{id}/likes", options, signature=true)
         response
       end
     end

data/lib/instagram/client/tags.rb

@@ -34,7 +34,7 @@ module Instagram
       # @rate_limited true
       def tag_recent_media(id, *args)
         options = args.last.is_a?(Hash) ? args.pop : {}
-        response = get("tags/#{id}/media/recent", options, false, false)
+        response = get("tags/#{id}/media/recent", options, false, false, false)
         response
       end
 

data/lib/instagram/client/users.rb

@@ -213,7 +213,7 @@ module Instagram
     # @rate_limited true
     def follow_user(id, options={})
       options["action"] = "follow"
-      response = post("users/#{id}/relationship", options)
+      response = post("users/#{id}/relationship", options, signature=true)
       response
     end
 
@@ -231,7 +231,7 @@ module Instagram
     # @rate_limited true
     def unfollow_user(id, options={})
       options["action"] = "unfollow"
-      response = post("users/#{id}/relationship", options)
+      response = post("users/#{id}/relationship", options, signature=true)
       response
     end
 
@@ -249,7 +249,7 @@ module Instagram
     # @rate_limited true
     def block_user(id, options={})
       options["action"] = "block"
-      response = post("users/#{id}/relationship", options)
+      response = post("users/#{id}/relationship", options, signature=true)
       response
     end
 
@@ -267,7 +267,7 @@ module Instagram
     # @rate_limited true
     def unblock_user(id, options={})
       options["action"] = "unblock"
-      response = post("users/#{id}/relationship", options)
+      response = post("users/#{id}/relationship", options, signature=true)
       response
     end
 
@@ -285,7 +285,7 @@ module Instagram
     # @rate_limited true
     def approve_user(id, options={})
       options["action"] = "approve"
-      response = post("users/#{id}/relationship", options)
+      response = post("users/#{id}/relationship", options, signature=true)
       response
     end
 
@@ -303,7 +303,7 @@ module Instagram
     # @rate_limited true
     def deny_user(id, options={})
       options["action"] = "deny"
-      response = post("users/#{id}/relationship", options)
+      response = post("users/#{id}/relationship", options, signature=true)
       response
     end
   end

data/lib/instagram/configuration.rb

@@ -10,6 +10,7 @@ module Instagram
       :adapter,
       :client_id,
       :client_secret,
+      :client_ips,
       :connection_options,
       :scope,
       :redirect_uri,
@@ -34,6 +35,9 @@ module Instagram
     # By default, don't set an application secret
     DEFAULT_CLIENT_SECRET = nil
 
+    # By default, don't set application IPs
+    DEFAULT_CLIENT_IPS = nil
+
     # By default, don't set any connection options
     DEFAULT_CONNECTION_OPTIONS = {}
 
@@ -94,6 +98,7 @@ module Instagram
       self.adapter            = DEFAULT_ADAPTER
       self.client_id          = DEFAULT_CLIENT_ID
       self.client_secret      = DEFAULT_CLIENT_SECRET
+      self.client_ips         = DEFAULT_CLIENT_IPS
       self.connection_options = DEFAULT_CONNECTION_OPTIONS
       self.scope              = DEFAULT_SCOPE
       self.redirect_uri       = DEFAULT_REDIRECT_URI
@@ -101,7 +106,7 @@ module Instagram
       self.format             = DEFAULT_FORMAT
       self.proxy              = DEFAULT_PROXY
       self.user_agent         = DEFAULT_USER_AGENT
-      self.no_response_wrapper= DEFAULT_NO_RESPONSE_WRAPPER      
+      self.no_response_wrapper= DEFAULT_NO_RESPONSE_WRAPPER
     end
   end
 end

data/lib/instagram/error.rb

@@ -8,6 +8,9 @@ module Instagram
   # Raised when Instagram returns the HTTP status code 404
   class NotFound < Error; end
 
+  # Raised when Instagram returns the HTTP status code 429
+  class TooManyRequests < Error; end
+
   # Raised when Instagram returns the HTTP status code 500
   class InternalServerError < Error; end
 
@@ -22,4 +25,7 @@ module Instagram
 
   # Raised when a subscription payload hash is invalid
   class InvalidSignature < Error; end
+
+  # Raised when Instagram returns the HTTP status code 429
+  class RateLimitExceeded < Error; end
 end

data/lib/instagram/oauth.rb

@@ -15,7 +15,7 @@ module Instagram
       options[:grant_type] ||= "authorization_code"
       options[:redirect_uri] ||= self.redirect_uri
       params = access_token_params.merge(options)
-      post("/oauth/access_token/", params.merge(:code => code), raw=false, unformatted=true, no_response_wrapper=true)
+      post("/oauth/access_token/", params.merge(:code => code), signature=false, raw=false, unformatted=true, no_response_wrapper=true)
     end
 
     private

data/lib/instagram/request.rb

@@ -1,30 +1,33 @@
+require 'openssl'
+require 'base64'
+
 module Instagram
   # Defines HTTP request methods
   module Request
     # Perform an HTTP GET request
-    def get(path, options={}, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper)
-      request(:get, path, options, raw, unformatted, no_response_wrapper)
+    def get(path, options={}, signature=false, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper)
+      request(:get, path, options, signature, raw, unformatted, no_response_wrapper)
     end
 
     # Perform an HTTP POST request
-    def post(path, options={}, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper)
-      request(:post, path, options, raw, unformatted, no_response_wrapper)
+    def post(path, options={}, signature=false, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper)
+      request(:post, path, options, signature, raw, unformatted, no_response_wrapper)
     end
 
     # Perform an HTTP PUT request
-    def put(path, options={}, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper)
-      request(:put, path, options, raw, unformatted, no_response_wrapper)
+    def put(path, options={},  signature=false, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper)
+      request(:put, path, options, signature, raw, unformatted, no_response_wrapper)
     end
 
     # Perform an HTTP DELETE request
-    def delete(path, options={}, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper)
-      request(:delete, path, options, raw, unformatted, no_response_wrapper)
+    def delete(path, options={}, signature=false, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper)
+      request(:delete, path, options, signature, raw, unformatted, no_response_wrapper)
     end
 
     private
 
     # Perform an HTTP request
-    def request(method, path, options, raw=false, unformatted=false, no_response_wrapper=false)
+    def request(method, path, options, signature=false, raw=false, unformatted=false, no_response_wrapper=false)
       response = connection(raw).send(method) do |request|
         path = formatted_path(path) unless unformatted
         case method
@@ -34,6 +37,9 @@ module Instagram
           request.path = path
           request.body = options unless options.empty?
         end
+        if signature && client_ips != nil
+          request.headers["X-Insta-Forwarded-For"] = get_insta_fowarded_for(client_ips, client_secret)
+        end
       end
       return response if raw
       return response.body if no_response_wrapper
@@ -43,5 +49,12 @@ module Instagram
     def formatted_path(path)
       [path, format].compact.join('.')
     end
+
+    def get_insta_fowarded_for(ips, secret)
+        digest = OpenSSL::Digest::Digest.new('sha256')
+        signature = OpenSSL::HMAC.hexdigest(digest, secret, ips)
+        return [ips, signature].join('|')
+    end
+
   end
 end

data/lib/instagram/version.rb

@@ -1,3 +1,3 @@
 module Instagram
-  VERSION = '1.0.0'.freeze unless defined?(::Instagram::VERSION)
+  VERSION = '1.1.0'.freeze unless defined?(::Instagram::VERSION)
 end

data/spec/faraday/response_spec.rb

@@ -8,6 +8,7 @@ describe Faraday::Response do
   {
     400 => Instagram::BadRequest,
     404 => Instagram::NotFound,
+    429 => Instagram::TooManyRequests,
     500 => Instagram::InternalServerError,
     503 => Instagram::ServiceUnavailable
   }.each do |status, exception|
@@ -36,7 +37,20 @@ describe Faraday::Response do
     it "should return the body error message" do
       expect do
         @client.user_media_feed()
-      end.to raise_error(Instagram::BadRequest, /Bad words are bad./)
+      end.to raise_error(Instagram::BadRequest, /Bad words are bad\./)
+    end
+  end
+
+  context "when a 400 is raised with no meta but an error_message" do
+    before do
+      stub_get('users/self/feed.json').
+        to_return(:body => '{"error_type": "OAuthException", "error_message": "No matching code found."}', :status => 400)
+    end
+
+    it "should return the body error type and message" do
+      expect do
+        @client.user_media_feed()
+      end.to raise_error(Instagram::BadRequest, /OAuthException: No matching code found\./)
     end
   end
 

data/spec/instagram/api_spec.rb

@@ -34,6 +34,7 @@ describe Instagram::API do
           :adapter => :typhoeus,
           :client_id => 'CID',
           :client_secret => 'CS',
+          :client_ips => '1.2.3.4',
           :connection_options => { :ssl => { :verify => true } },
           :redirect_uri => 'http://http://localhost:4567/oauth/callback',
           :endpoint => 'http://tumblr.com/',

data/spec/instagram/client/likes_spec.rb

@@ -5,7 +5,7 @@ describe Instagram::Client do
     context ".new(:format => '#{format}')" do
 
       before do
-        @client = Instagram::Client.new(:format => format, :client_id => 'CID', :client_secret => 'CS', :access_token => 'AT')
+        @client = Instagram::Client.new(:format => format, :client_id => 'CID', :client_secret => 'CS', :client_ips => '1.2.3.4', :access_token => 'AT')
       end
 
       describe ".media_likes" do

data/spec/instagram/request_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Instagram::Request do
+  describe "#post" do
+    before do
+      @ips = "1.2.3.4"
+      @secret = "CS"
+      digest = OpenSSL::Digest::Digest.new('sha256')
+      signature = OpenSSL::HMAC.hexdigest(digest, @secret, @ips)
+      @signed_header = [@ips, signature].join('|')
+    end
+
+    context "with signature=true" do
+      it "should set X-Insta-Forwarded-For header" do
+        client = Instagram::Client.new(:client_id => "CID", :client_secret => @secret, :client_ips => @ips, :access_token => "AT")
+        url = client.send(:connection).build_url("/media/123/likes.json").to_s
+        stub_request(:post, url).
+          with(:body => {"access_token"=>"AT"}).
+          to_return(:status => 200, :body => "", :headers => {})
+
+        client.post("/media/123/likes", {}, signature=true)
+        a_request(:post, url).
+          with(:headers => {'X-Insta-Forwarded-For'=> @signed_header}).
+          should have_been_made
+      end
+
+      it "should not set X-Insta-Fowarded-For header if client_ips is not provided" do
+        client = Instagram::Client.new(:client_id => "CID", :client_secret => @secret, :access_token => "AT")
+        url = client.send(:connection).build_url("/media/123/likes.json").to_s
+        stub_request(:post, url).
+          with(:body => {"access_token"=>"AT"}).
+          to_return(:status => 200, :body => "", :headers => {})
+
+        client.post("/media/123/likes", {}, signature=true)
+        a_request(:post, url).
+          with(:headers => {'X-Insta-Forwarded-For'=> @signed_header}).
+          should_not have_been_made
+      end
+    end
+
+    context "with signature=false" do
+      it "should set X-Insta-Forwarded-For header" do
+        client = Instagram::Client.new(:client_id => "CID", :client_secret => @secret, :client_ips => @ips, :access_token => "AT")
+        url = client.send(:connection).build_url("/media/123/likes.json").to_s
+        stub_request(:post, url).
+          with(:body => {"access_token"=>"AT"}).
+          to_return(:status => 200, :body => "", :headers => {})
+
+        client.post("/media/123/likes", {}, signature=false)
+        a_request(:post, url).
+          with(:headers => {'X-Insta-Forwarded-For'=> @signed_header}).
+          should_not have_been_made
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: instagram
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Shayne Sweeney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -135,6 +149,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - .yardopts
 - Gemfile
 - LICENSE.md
@@ -215,21 +230,55 @@ files:
 - spec/instagram/client/tags_spec.rb
 - spec/instagram/client/users_spec.rb
 - spec/instagram/client_spec.rb
+- spec/instagram/request_spec.rb
 - spec/instagram_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Instagram/instagram-ruby-gem
 licenses: []
 metadata: {}
-post_install_message: ! "********************************************************************************\n\nInstagram
-  REST and Search APIs\n------------------------------\nOur developer site documents
-  all the Instagram REST and Search APIs.\n(http://instagram.com/developer)\n\nBlog\n----------------------------\nThe
-  Developer Blog features news and important announcements about the Instagram Platform.
-  \nYou will also find tutorials and best practices to help you build great platform
-  integrations.\nMake sure to subscribe to the RSS feed so you don't miss out on new
-  posts: \n(http://developers.instagram.com).\n\nCommunity\n----------------------\nThe
-  Stack Overflow community is a great place to ask API related questions or if you
-  need help with your code.\nMake sure to tag your questions with the Instagram tag
-  to get fast answers from other fellow developers and members of the Instagram team.\n(http://stackoverflow.com/questions/tagged/instagram/)\n\n********************************************************************************\n"
+post_install_message: ! '********************************************************************************
+
+
+  Instagram REST and Search APIs
+
+  ------------------------------
+
+  Our developer site documents all the Instagram REST and Search APIs.
+
+  (http://instagram.com/developer)
+
+
+  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/)
+
+
+  ********************************************************************************
+
+'
 rdoc_options: []
 require_paths:
 - lib
@@ -301,6 +350,7 @@ test_files:
 - spec/instagram/client/tags_spec.rb
 - spec/instagram/client/users_spec.rb
 - spec/instagram/client_spec.rb
+- spec/instagram/request_spec.rb
 - spec/instagram_spec.rb
 - spec/spec_helper.rb
 has_rdoc: