RubyGems - instagram - Versions diffs - 0.11.0 → 1.0.0 - Mend

instagram 0.11.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (31) hide show

checksums.yaml +8 -8
data/.gitignore +1 -0
data/LICENSE.md +27 -17
data/PATENTS.md +23 -0
data/README.md +129 -46
data/instagram.gemspec +18 -6
data/lib/faraday/raise_http_exception.rb +4 -0
data/lib/instagram/api.rb +8 -0
data/lib/instagram/client.rb +2 -2
data/lib/instagram/client/comments.rb +3 -3
data/lib/instagram/client/embedding.rb +17 -0
data/lib/instagram/client/likes.rb +3 -3
data/lib/instagram/client/locations.rb +6 -3
data/lib/instagram/client/media.rb +3 -3
data/lib/instagram/client/subscriptions.rb +57 -2
data/lib/instagram/client/tags.rb +6 -6
data/lib/instagram/client/users.rb +15 -15
data/lib/instagram/client/utils.rb +13 -0
data/lib/instagram/configuration.rb +37 -25
data/lib/instagram/connection.rb +1 -1
data/lib/instagram/error.rb +6 -0
data/lib/instagram/oauth.rb +2 -0
data/lib/instagram/request.rb +4 -4
data/lib/instagram/version.rb +1 -1
data/spec/faraday/response_spec.rb +30 -0
data/spec/instagram/api_spec.rb +97 -21
data/spec/instagram/client/locations_spec.rb +24 -0
data/spec/instagram/client/subscriptions_spec.rb +8 -5
data/spec/instagram/client/tags_spec.rb +1 -0
data/spec/instagram/client_spec.rb +1 -1
metadata +23 -9

data/lib/instagram/connection.rb CHANGED Viewed

@@ -11,7 +11,7 @@ module Instagram
         :headers => {'Accept' => "application/#{format}; charset=utf-8", 'User-Agent' => user_agent},
         :proxy => proxy,
         :url => endpoint,
-      }
+      }.merge(connection_options)
       Faraday::Connection.new(options) do |connection|
         connection.use FaradayMiddleware::InstagramOAuth2, client_id, access_token

data/lib/instagram/error.rb CHANGED Viewed

@@ -11,9 +11,15 @@ module Instagram
   # Raised when Instagram returns the HTTP status code 500
   class InternalServerError < Error; end
+  # Raised when Instagram returns the HTTP status code 502
+  class BadGateway < Error; end
   # Raised when Instagram returns the HTTP status code 503
   class ServiceUnavailable < Error; end
+  # Raised when Instagram returns the HTTP status code 504
+  class GatewayTimeout < Error; end
   # Raised when a subscription payload hash is invalid
   class InvalidSignature < Error; end
 end

data/lib/instagram/oauth.rb CHANGED Viewed

@@ -5,6 +5,7 @@ module Instagram
     def authorize_url(options={})
       options[:response_type] ||= "code"
       options[:scope] ||= scope if !scope.nil? && !scope.empty?
+      options[:redirect_uri] ||= self.redirect_uri
       params = authorization_params.merge(options)
       connection.build_url("/oauth/authorize/", params).to_s
     end
@@ -12,6 +13,7 @@ module Instagram
     # Return an access token from authorization
     def get_access_token(code, options={})
       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)
     end

data/lib/instagram/request.rb CHANGED Viewed

@@ -2,22 +2,22 @@ module Instagram
   # Defines HTTP request methods
   module Request
     # Perform an HTTP GET request
-    def get(path, options={}, raw=false, unformatted=false, no_response_wrapper=false)
+    def get(path, options={}, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper)
       request(:get, path, options, raw, unformatted, no_response_wrapper)
     end
     # Perform an HTTP POST request
-    def post(path, options={}, raw=false, unformatted=false, no_response_wrapper=false)
+    def post(path, options={}, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper)
       request(:post, path, options, raw, unformatted, no_response_wrapper)
     end
     # Perform an HTTP PUT request
-    def put(path, options={}, raw=false, unformatted=false, no_response_wrapper=false)
+    def put(path, options={}, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper)
       request(:put, path, options, raw, unformatted, no_response_wrapper)
     end
     # Perform an HTTP DELETE request
-    def delete(path, options={}, raw=false, unformatted=false, no_response_wrapper=false)
+    def delete(path, options={}, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper)
       request(:delete, path, options, raw, unformatted, no_response_wrapper)
     end

data/lib/instagram/version.rb CHANGED Viewed

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

data/spec/faraday/response_spec.rb CHANGED Viewed

@@ -39,4 +39,34 @@ describe Faraday::Response do
       end.to raise_error(Instagram::BadRequest, /Bad words are bad./)
     end
   end
+  context 'when a 502 is raised with an HTML response' do
+    before do
+      stub_get('users/self/feed.json').to_return(
+        :body => '<html><body><h1>502 Bad Gateway</h1> The server returned an invalid or incomplete response. </body></html>',
+        :status => 502
+      )
+    end
+    it 'should raise an Instagram::BadGateway' do
+      lambda do
+        @client.user_media_feed()
+      end.should raise_error(Instagram::BadGateway)
+    end
+  end
+  context 'when a 504 is raised with an HTML response' do
+    before do
+      stub_get('users/self/feed.json').to_return(
+        :body => '<html> <head><title>504 Gateway Time-out</title></head> <body bgcolor="white"> <center><h1>504 Gateway Time-out</h1></center> <hr><center>nginx</center> </body> </html>',
+        :status => 504
+      )
+    end
+    it 'should raise an Instagram::GatewayTimeout' do
+      lambda do
+        @client.user_media_feed()
+      end.should raise_error(Instagram::GatewayTimeout)
+    end
+  end
 end

data/spec/instagram/api_spec.rb CHANGED Viewed

@@ -30,15 +30,18 @@ describe Instagram::API do
       before do
         @configuration = {
-          :client_id => 'CID',
-          :client_secret => 'CS',
-          :scope => 'comments relationships',
           :access_token => 'AT',
           :adapter => :typhoeus,
+          :client_id => 'CID',
+          :client_secret => 'CS',
+          :connection_options => { :ssl => { :verify => true } },
+          :redirect_uri => 'http://http://localhost:4567/oauth/callback',
           :endpoint => 'http://tumblr.com/',
           :format => :xml,
           :proxy => 'http://shayne:sekret@proxy.example.com:8080',
+          :scope => 'comments relationships',
           :user_agent => 'Custom User Agent',
+          :no_response_wrapper => true,
         }
       end
@@ -53,16 +56,42 @@ describe Instagram::API do
       context "after initilization" do
-        it "should override module configuration after initialization" do
-          api = Instagram::API.new
+        let(:api) { Instagram::API.new }
+        before do
           @configuration.each do |key, value|
             api.send("#{key}=", value)
           end
+        end
+        it "should override module configuration after initialization" do
           @keys.each do |key|
             api.send(key).should == @configuration[key]
           end
         end
+        describe "#connection" do
+          it "should use the connection_options" do
+            Faraday::Connection.should_receive(:new).with(include(:ssl => { :verify => true }))
+            api.send(:connection)
+          end
+        end
+      end
+    end
+  end
+  describe '#config' do
+    subject { Instagram::API.new }
+    let(:config) do
+      c = {}; @keys.each {|key| c[key] = key }; c
+    end
+    it "returns a hash representing the configuration" do
+      @keys.each do |key|
+        subject.send("#{key}=", key)
       end
+      subject.config.should == config
     end
   end
@@ -112,29 +141,76 @@ describe Instagram::API do
         url.should_not include("scope")
       end
     end
+    describe "redirect_uri" do
+      it "should fall back to configuration redirect_uri if not passed as option" do
+        redirect_uri = 'http://localhost:4567/oauth/callback'
+        params = { :redirect_uri => redirect_uri }
+        client = Instagram::Client.new(params)
+        url = client.authorize_url()
+        url.should =~ /redirect_uri=#{URI.escape(redirect_uri, Regexp.union('/',':'))}/
+      end
+      it "should override configuration redirect_uri if passed as option" do
+        redirect_uri_config = 'http://localhost:4567/oauth/callback_config'
+        params = { :redirect_uri => redirect_uri_config }
+        client = Instagram::Client.new(params)
+        redirect_uri_option = 'http://localhost:4567/oauth/callback_option'
+        options = { :redirect_uri => redirect_uri_option }
+        url = client.authorize_url(options)
+        url.should =~ /redirect_uri=#{URI.escape(redirect_uri_option, Regexp.union('/',':'))}/
+      end
+    end
   end
   describe ".get_access_token" do
-    before do
-      @client = Instagram::Client.new(:client_id => "CID", :client_secret => "CS")
-      @url = @client.send(:connection).build_url("/oauth/access_token/").to_s
-      stub_request(:post, @url).
-        with(:body => {:client_id => "CID", :client_secret => "CS", :redirect_uri => "http://localhost:4567/oauth/callback", :grant_type => "authorization_code", :code => "C"}).
-        to_return(:status => 200, :body => fixture("access_token.json"), :headers => {})
-    end
+    describe "common functionality" do
+      before do
+        @client = Instagram::Client.new(:client_id => "CID", :client_secret => "CS")
+        @url = @client.send(:connection).build_url("/oauth/access_token/").to_s
+        stub_request(:post, @url).
+          with(:body => {:client_id => "CID", :client_secret => "CS", :redirect_uri => "http://localhost:4567/oauth/callback", :grant_type => "authorization_code", :code => "C"}).
+          to_return(:status => 200, :body => fixture("access_token.json"), :headers => {})
+      end
+      it "should get the correct resource" do
+        @client.get_access_token(code="C", :redirect_uri => "http://localhost:4567/oauth/callback")
+        a_request(:post, @url).
+          with(:body => {:client_id => "CID", :client_secret => "CS", :redirect_uri => "http://localhost:4567/oauth/callback", :grant_type => "authorization_code", :code => "C"}).
+          should have_been_made
+      end
-    it "should get the correct resource" do
-      @client.get_access_token(code="C", :redirect_uri => "http://localhost:4567/oauth/callback")
-      a_request(:post, @url).
-        with(:body => {:client_id => "CID", :client_secret => "CS", :redirect_uri => "http://localhost:4567/oauth/callback", :grant_type => "authorization_code", :code => "C"}).
-        should have_been_made
+      it "should return a hash with an access_token and user data" do
+        response = @client.get_access_token(code="C", :redirect_uri => "http://localhost:4567/oauth/callback")
+        response.access_token.should == "at"
+        response.user.username.should == "mikeyk"
+      end
     end
-    it "should return a hash with an access_token and user data" do
-      response = @client.get_access_token(code="C", :redirect_uri => "http://localhost:4567/oauth/callback")
-      response.access_token.should == "at"
-      response.user.username.should == "mikeyk"
+    describe "redirect_uri param" do
+      before do
+        @redirect_uri_config = "http://localhost:4567/oauth/callback_config"
+        @client = Instagram::Client.new(:client_id => "CID", :client_secret => "CS", :redirect_uri => @redirect_uri_config)
+        @url = @client.send(:connection).build_url("/oauth/access_token/").to_s
+        stub_request(:post, @url)
+      end
+      it "should fall back to configuration redirect_uri if not passed as option" do
+        @client.get_access_token(code="C")
+        a_request(:post, @url).
+          with(:body => hash_including({:redirect_uri => @redirect_uri_config})).
+          should have_been_made
+      end
+      it "should override configuration redirect_uri if passed as option" do
+        redirect_uri_option = "http://localhost:4567/oauth/callback_option"
+        @client.get_access_token(code="C", :redirect_uri => redirect_uri_option)
+        a_request(:post, @url).
+          with(:body => hash_including({:redirect_uri => redirect_uri_option})).
+          should have_been_made
+      end
     end
   end
 end

data/spec/instagram/client/locations_spec.rb CHANGED Viewed

@@ -74,6 +74,30 @@ describe Instagram::Client do
         end
       end
+      describe ".location_search_lat_lng_distance" do
+        before do
+          stub_get("locations/search.#{format}").
+            with(:query => {:access_token => @client.access_token}).
+            with(:query => {:lat => "37.7808851", :lng => "-122.3948632", :distance => "5000"}).
+            to_return(:body => fixture("location_search.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+        end
+        it "should get the correct resource by lat/lng/distance" do
+          @client.location_search("37.7808851", "-122.3948632", "5000")
+          a_get("locations/search.#{format}").
+            with(:query => {:access_token => @client.access_token}).
+            with(:query => {:lat => "37.7808851", :lng => "-122.3948632", :distance => "5000"}).
+            should have_been_made
+        end
+        it "should return an array of user search results" do
+          locations = @client.location_search("37.7808851", "-122.3948632", "5000")
+          locations.should be_a Array
+          locations.first.name.should == "Instagram"
+        end
+      end
       describe ".location_search_foursquare_v2_id" do
         before do

data/spec/instagram/client/subscriptions_spec.rb CHANGED Viewed

@@ -136,11 +136,14 @@ describe Instagram::Client do
         end
         it "should raise an Instagram::InvalidSignature error" do
-          lambda do
-            @client.process_subscription(@json, :signature => "31337H4X0R") do |handler|
-              # hi
-            end
-          end.should raise_error(Instagram::InvalidSignature)
+          invalid_signatures = ["31337H4X0R", nil]
+          invalid_signatures.each do |signature|
+            lambda do
+              @client.process_subscription(@json, :signature => signature ) do |handler|
+                # hi
+              end
+            end.should raise_error(Instagram::InvalidSignature)
+          end
         end
       end
     end

data/spec/instagram/client/tags_spec.rb CHANGED Viewed

@@ -48,6 +48,7 @@ describe Instagram::Client do
           media.should be_a Array
           media.first.user.username.should == "amandavan"
         end
       end
       describe ".tag_search" do

data/spec/instagram/client_spec.rb CHANGED Viewed

@@ -5,7 +5,7 @@ describe Instagram::Client do
     client = Instagram::Client.new
     endpoint = URI.parse(client.endpoint)
     connection = client.send(:connection).build_url(nil).to_s
-    (connection + '/').should == endpoint.to_s
+    (connection).should == endpoint.to_s
   end
   it "should not cache the user account across clients" do

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instagram
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Shayne Sweeney
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2014-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -61,7 +61,7 @@ dependencies:
         version: '0.7'
     - - <
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,21 +71,27 @@ dependencies:
         version: '0.7'
     - - <
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +138,7 @@ files:
 - .yardopts
 - Gemfile
 - LICENSE.md
+- PATENTS.md
 - README.md
 - Rakefile
 - instagram.gemspec
@@ -213,9 +220,16 @@ files:
 homepage: https://github.com/Instagram/instagram-ruby-gem
 licenses: []
 metadata: {}
-post_install_message: ! "********************************************************************************\n\n
-  \ Follow @instagramapi on Twitter for announcements, updates, and news.\n  https://twitter.com/instagramapi\n\n
-  \ Join the mailing list!\n  https://groups.google.com/group/instagram-ruby-gem\n\n********************************************************************************\n"
+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"
 rdoc_options: []
 require_paths:
 - lib