instagram 0.8.5 → 0.9.0

data/README.md

@@ -68,6 +68,13 @@ API Usage Examples
 ------------------
     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
+    end
 
     # Get a list of a user's most recent media
     puts Instagram.user_recent_media(777)
@@ -78,16 +85,6 @@ API Usage Examples
     # Get a list of recent media at a given location, in this case, the Instagram office
     puts Instagram.location_recent_media(514276)
 
-    # 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
-    end
-
-    # Get a list of all the users you're following
-    puts Instagram.follows
-
     # Get a list of media close to a given latitude and longitude
     puts Instagram.media_search("37.7808851","-122.3948632")
 
@@ -97,6 +94,14 @@ API Usage Examples
 	# Search for users on instagram, by name or username
 	puts Instagram.user_search("shayne sweeney")
 
+	# Search for a location by lat/lng
+	puts Instagram.location_search("37.7808851","-122.3948632")
+
+	# Search for a location by Fousquare ID (v2)
+	puts Instagram.location_search("3fd66200f964a520c5f11ee3")
+
+	
+
 
 Contributing
 ------------

data/instagram.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.post_install_message =<<eos
 ********************************************************************************
 
-  Follow @instagram on Twitter for announcements, updates, and news.
+  Follow @instagramapi on Twitter for announcements, updates, and news.
   https://twitter.com/instagramapi
 
   Join the mailing list!

data/lib/faraday/oauth2.rb

@@ -3,7 +3,7 @@ require 'faraday'
 # @private
 module FaradayMiddleware
   # @private
-  class OAuth2 < Faraday::Middleware
+  class InstagramOAuth2 < Faraday::Middleware
     def call(env)
 
       if env[:method] == :get or env[:method] == :delete

data/lib/instagram/client.rb

@@ -16,5 +16,6 @@ module Instagram
     include Instagram::Client::Comments
     include Instagram::Client::Likes
     include Instagram::Client::Subscriptions
+    include Instagram::Client::Embedding
   end
-end
+end

data/lib/instagram/client/embedding.rb

@@ -0,0 +1,11 @@
+module Instagram
+  class Client
+    module Embedding
+      def oembed(*args)
+        url = args.first
+        return nil unless url
+        get("oembed?url=#{url}", {}, false, true)
+      end
+    end
+  end
+end

data/lib/instagram/client/locations.rb

@@ -38,20 +38,32 @@ module Instagram
         response
       end
 
-      # Returns Instagram locations within proximity of given lat,lng
+      # Returns Instagram locations within proximity of given lat,lng or foursquare venue id
       #
-      # @param lat [String] A given latitude in decimal format
-      # @param lng [String] A given longitude in decimal format
-      # @option options [Integer] :count The number of media items to retrieve.
-      # @return [Array]
-      # @example Return locations around 37.7808851, -122.3948632 (164 S Park, SF, CA USA)
-      #   Instagram.location_search("37.7808851", "-122.3948632")
+      # @overload location_search(options={})
+      #   @param foursquare_v2_id [String] A valid Foursquare Venue ID (v2)
+      #   @param lat [String] A given latitude in decimal format
+      #   @param lng [String] A given longitude in decimal format
+      #   @option options [Integer] :count The number of media items to retrieve.
+      #   @return [Array]
+      #   @example 1: Return a location with the Foursquare Venue ID = ()
+      #     Instagram.location_search("3fd66200f964a520c5f11ee3") (Schiller's Liquor Bar, 131 Rivington St., NY, NY 10002)
+      #   @example 2: Return locations around 37.7808851, -122.3948632 (164 S Park, SF, CA USA)
+      #     Instagram.location_search("37.7808851", "-122.3948632")
       # @see TODO:doc url
       # @format :json
       # @authenticated false
       # @rate_limited true
-      def location_search(lat, lng, options={})
-        response = get('locations/search', options.merge(:lat => lat, :lng => lng))
+      def location_search(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        case args.size
+        when 1
+          foursquare_v2_id = args.first
+          response = get('locations/search', options.merge(:foursquare_v2_id => foursquare_v2_id))
+        when 2
+          lat, lng = args
+          response = get('locations/search', options.merge(:lat => lat, :lng => lng))
+        end
         response["data"]
       end
     end

data/lib/instagram/connection.rb

@@ -15,7 +15,7 @@ module Instagram
       }
 
       Faraday::Connection.new(options) do |connection|
-        connection.use FaradayMiddleware::OAuth2, client_id, access_token
+        connection.use FaradayMiddleware::InstagramOAuth2, client_id, access_token
         connection.use Faraday::Request::UrlEncoded
         connection.use FaradayMiddleware::Mashify unless raw
         unless raw

data/lib/instagram/oauth.rb

@@ -4,7 +4,7 @@ module Instagram
     # Return URL for OAuth authorization
     def authorize_url(options={})
       options[:response_type] ||= "code"
-      params = access_token_params.merge(options)
+      params = authorization_params.merge(options)
       connection.build_url("/oauth/authorize/", params).to_s
     end
 
@@ -17,6 +17,12 @@ module Instagram
 
     private
 
+    def authorization_params
+      {
+        :client_id => client_id
+      }
+    end
+
     def access_token_params
       {
         :client_id => client_id,

data/lib/instagram/version.rb

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

data/spec/faraday/response_spec.rb

@@ -36,7 +36,7 @@ describe Faraday::Response do
     it "should return the body error message" do
       expect do
         @client.user_media_feed()
-      end.should raise_error(Instagram::BadRequest, /Bad words are bad./)
+      end.to raise_error(Instagram::BadRequest, /Bad words are bad./)
     end
   end
 end

data/spec/fixtures/location_search_fsq.json

@@ -0,0 +1 @@
+{"meta": {"code": 200}, "data": [{"latitude": 40.719607, "longitude": -73.986764, "id": "1075772", "name": "Schiller's Liquor Bar"}]}

data/spec/fixtures/oembed.json

@@ -0,0 +1,14 @@
+{
+    "provider_url": "http:\/\/instagram.com\/",
+    "media_id": "123657555223544123_41812344",
+    "title": "I like this title #hash",
+    "url": "http:\/\/distilleryimage4.s3.amazonaws.com\/7.jpg",
+    "author_name": "my_name",
+    "height": 612,
+    "width": 612,
+    "version": "1.0",
+    "author_url": "http:\/\/instagram.com\/",
+    "author_id": 1234,
+    "type": "photo",
+    "provider_name": "Instagram"
+}

data/spec/instagram/api_spec.rb

@@ -75,13 +75,24 @@ describe Instagram::API do
       redirect_uri = 'http://localhost:4567/oauth/callback'
       url = client.authorize_url(:redirect_uri => redirect_uri)
 
-      params2 = client.send(:access_token_params).merge(params)
-      params2[:redirect_uri] = redirect_uri
-      params2[:response_type] = "code"
+      options = {
+        :redirect_uri => redirect_uri,
+        :response_type => "code"
+      }
+      params2 = client.send(:authorization_params).merge(options)
+
       url2 = client.send(:connection).build_url("/oauth/authorize/", params2).to_s
 
       url2.should == url
     end
+
+    it "should not include client secret in URL params" do
+      params = { :client_id => "CID", :client_secret => "CS" }
+      client = Instagram::Client.new(params)
+      redirect_uri = 'http://localhost:4567/oauth/callback'
+      url = client.authorize_url(:redirect_uri => redirect_uri)
+      url.should_not include("client_secret")
+    end
   end
 
   describe ".get_access_token" do

data/spec/instagram/client/embedding_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe Instagram::Client do
+  Instagram::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = Instagram::Client.new(:format => format, :client_id => 'CID', :client_secret => 'CS', :access_token => 'AT')
+      end
+
+      describe ".oembed" do
+        before do
+          stub_get("oembed").
+            with(:query => {:access_token => @client.access_token, :url => "http://instagram.com/p/abcdef"}).
+            to_return(:body => fixture("oembed.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+        end
+
+        it "should get the correct resource" do
+          @client.oembed("http://instagram.com/p/abcdef")
+          a_get("oembed?url=http://instagram.com/p/abcdef").
+            with(:query => {:access_token => @client.access_token}).
+            should have_been_made
+        end
+
+        it "should return the oembed information for an instagram media url" do
+          oembed = @client.oembed("http://instagram.com/p/abcdef")
+          oembed.media_id.should == "123657555223544123_41812344"
+        end
+
+        it "should return nil if a URL is not provided" do
+          oembed = @client.oembed
+          oembed.should be_nil
+        end
+      end
+    end
+  end
+end

data/spec/instagram/client/locations_spec.rb

@@ -50,7 +50,7 @@ describe Instagram::Client do
         end
       end
 
-      describe ".location_search" do
+      describe ".location_search_lat_lng" do
 
         before do
           stub_get("locations/search.#{format}").
@@ -59,7 +59,7 @@ describe Instagram::Client do
             to_return(:body => fixture("location_search.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
         end
 
-        it "should get the correct resource" do
+        it "should get the correct resource by lat/lng" do
           @client.location_search("37.7808851", "-122.3948632")
           a_get("locations/search.#{format}").
             with(:query => {:access_token => @client.access_token}).
@@ -73,6 +73,31 @@ describe Instagram::Client do
           locations.first.name.should == "Instagram"
         end
       end
+
+      describe ".location_search_foursquare_v2_id" do
+
+        before do
+          stub_get("locations/search.#{format}").
+            with(:query => {:access_token => @client.access_token}).
+            with(:query => {:foursquare_v2_id => "3fd66200f964a520c5f11ee3"}).
+            to_return(:body => fixture("location_search_fsq.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+        end
+
+        it "should get the correct resource by foursquare_v2_id" do
+          @client.location_search("3fd66200f964a520c5f11ee3")
+          a_get("locations/search.#{format}").
+            with(:query => {:access_token => @client.access_token}).
+            with(:query => {:foursquare_v2_id => "3fd66200f964a520c5f11ee3"}).
+            should have_been_made
+        end
+
+        it "should return an array of user search results" do
+          locations = @client.location_search("3fd66200f964a520c5f11ee3")
+          locations.should be_a Array
+          locations.first.name.should == "Schiller's Liquor Bar"
+        end
+      end
+
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: instagram
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-13 00:00:00.000000000Z
+date: 2013-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70311845220480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *70311845220480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70311845218780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *70311845218780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &70311845217920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 2.0.11
   type: :development
   prerelease: false
-  version_requirements: *70311845217920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.11
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70311845217080 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +72,18 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *70311845217080
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70311845215700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +91,15 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70311845215700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70311845214840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -82,10 +110,18 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70311845214840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70311845213800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -93,7 +129,12 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70311845213800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 description: A Ruby wrapper for the Instagram REST and Search APIs
 email:
 - shayne@instagr.am
@@ -115,6 +156,7 @@ files:
 - lib/instagram/api.rb
 - lib/instagram/client.rb
 - lib/instagram/client/comments.rb
+- lib/instagram/client/embedding.rb
 - lib/instagram/client/geographies.rb
 - lib/instagram/client/likes.rb
 - lib/instagram/client/locations.rb
@@ -142,6 +184,7 @@ files:
 - spec/fixtures/location.json
 - spec/fixtures/location_recent_media.json
 - spec/fixtures/location_search.json
+- spec/fixtures/location_search_fsq.json
 - spec/fixtures/media.json
 - spec/fixtures/media_comment.json
 - spec/fixtures/media_comment_deleted.json
@@ -152,6 +195,7 @@ files:
 - spec/fixtures/media_search.json
 - spec/fixtures/media_unliked.json
 - spec/fixtures/mikeyk.json
+- spec/fixtures/oembed.json
 - spec/fixtures/recent_media.json
 - spec/fixtures/relationship.json
 - spec/fixtures/requested_by.json
@@ -169,6 +213,7 @@ files:
 - spec/fixtures/user_search.json
 - spec/instagram/api_spec.rb
 - spec/instagram/client/comments_spec.rb
+- spec/instagram/client/embedding_spec.rb
 - spec/instagram/client/geography_spec.rb
 - spec/instagram/client/likes_spec.rb
 - spec/instagram/client/locations_spec.rb
@@ -182,7 +227,7 @@ files:
 homepage: https://github.com/Instagram/instagram-ruby-gem
 licenses: []
 post_install_message: ! "********************************************************************************\n\n
-  \ Follow @instagram on Twitter for announcements, updates, and news.\n  https://twitter.com/instagramapi\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"
 rdoc_options: []
 require_paths:
@@ -195,7 +240,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1111246945157108473
+      hash: 3320943877353398037
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -204,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: instagram
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the Instagram API
@@ -222,6 +267,7 @@ test_files:
 - spec/fixtures/location.json
 - spec/fixtures/location_recent_media.json
 - spec/fixtures/location_search.json
+- spec/fixtures/location_search_fsq.json
 - spec/fixtures/media.json
 - spec/fixtures/media_comment.json
 - spec/fixtures/media_comment_deleted.json
@@ -232,6 +278,7 @@ test_files:
 - spec/fixtures/media_search.json
 - spec/fixtures/media_unliked.json
 - spec/fixtures/mikeyk.json
+- spec/fixtures/oembed.json
 - spec/fixtures/recent_media.json
 - spec/fixtures/relationship.json
 - spec/fixtures/requested_by.json
@@ -249,6 +296,7 @@ test_files:
 - spec/fixtures/user_search.json
 - spec/instagram/api_spec.rb
 - spec/instagram/client/comments_spec.rb
+- spec/instagram/client/embedding_spec.rb
 - spec/instagram/client/geography_spec.rb
 - spec/instagram/client/likes_spec.rb
 - spec/instagram/client/locations_spec.rb