extendi-instagram 2.0.0

data/lib/instagram/client/utils.rb

@@ -0,0 +1,28 @@
+module Instagram
+  class Client
+    # @private
+    module Utils
+      # Returns the raw full response including all headers. Can be used to access the values for 'X-Ratelimit-Limit' and 'X-Ratelimit-Remaining' 
+      # ==== Examples
+      #   
+      #   client = Instagram.client(:access_token => session[:access_token])
+      #   response = client.utils_raw_response
+      #   remaining = response.headers[:x_ratelimit_remaining]
+      #   limit = response.headers[:x_ratelimit_limit]
+      #
+      def utils_raw_response
+        response = get('users/self/feed',nil, false, true)
+        response
+      end
+    
+      private
+
+      # Returns the configured user name or the user name of the authenticated user
+      #
+      # @return [String]
+      def get_username
+        @user_name ||= self.user.username
+      end
+    end
+  end
+end

data/lib/instagram/client.rb

@@ -0,0 +1,21 @@
+module Instagram
+  # Wrapper for the Instagram REST API
+  #
+  # @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}
+
+    include Instagram::Client::Utils
+
+    include Instagram::Client::Users
+    include Instagram::Client::Media
+    include Instagram::Client::Locations
+    include Instagram::Client::Geographies
+    include Instagram::Client::Tags
+    include Instagram::Client::Comments
+    include Instagram::Client::Likes
+    include Instagram::Client::Subscriptions
+    include Instagram::Client::Embedding
+  end
+end

data/lib/instagram/configuration.rb

@@ -0,0 +1,125 @@
+require 'faraday'
+#if using typhoeus as the adapter uncomment these two requires to avoid seeing "Ethon::Errors::InvalidOption: The option: disable_ssl_peer_verification is invalid." (https://github.com/typhoeus/typhoeus/issues/270)
+#require 'typhoeus'
+#require 'typhoeus/adapters/faraday'
+require File.expand_path('../version', __FILE__)
+
+module Instagram
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Instagram::API}
+    VALID_OPTIONS_KEYS = [
+      :access_token,
+      :adapter,
+      :client_id,
+      :client_secret,
+      :client_ips,
+      :connection_options,
+      :scope,
+      :redirect_uri,
+      :endpoint,
+      :format,
+      :proxy,
+      :user_agent,
+      :no_response_wrapper,
+      :loud_logger,
+      :sign_requests,
+    ].freeze
+
+    # By default, don't set a user access token
+    DEFAULT_ACCESS_TOKEN = nil
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set an application ID
+    DEFAULT_CLIENT_ID = nil
+
+    # 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 = {}
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note There is no reason to use any other endpoint at this time
+    DEFAULT_ENDPOINT = 'https://api.instagram.com/v1/'.freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is the only available format at this time
+    DEFAULT_FORMAT = :json
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # By default, don't set an application redirect uri
+    DEFAULT_REDIRECT_URI = nil
+
+    # By default, don't set a user scope
+    DEFAULT_SCOPE = nil
+
+    # By default, don't wrap responses with meta data (i.e. pagination)
+    DEFAULT_NO_RESPONSE_WRAPPER = false
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Instagram Ruby Gem #{Instagram::VERSION}".freeze
+
+    # An array of valid request/response formats
+    #
+    # @note Not all methods support the XML format.
+    VALID_FORMATS = [
+      :json].freeze
+
+    # By default, don't turn on loud logging
+    DEFAULT_LOUD_LOGGER = nil
+
+    # By default, requests are not signed
+    DEFAULT_SIGN_REQUESTS = false
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.access_token       = DEFAULT_ACCESS_TOKEN
+      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
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.format             = DEFAULT_FORMAT
+      self.proxy              = DEFAULT_PROXY
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.no_response_wrapper= DEFAULT_NO_RESPONSE_WRAPPER
+      self.loud_logger        = DEFAULT_LOUD_LOGGER
+      self.sign_requests      = DEFAULT_SIGN_REQUESTS
+    end
+  end
+end

data/lib/instagram/connection.rb

@@ -0,0 +1,31 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module Instagram
+  # @private
+  module Connection
+    private
+
+    def connection(raw=false)
+      options = {
+        :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
+        connection.use Faraday::Request::UrlEncoded
+        connection.use FaradayMiddleware::Mashify unless raw
+        unless raw
+          case format.to_s.downcase
+          when 'json' then connection.use Faraday::Response::ParseJson
+          end
+        end
+        connection.use FaradayMiddleware::RaiseHttpException
+        connection.use FaradayMiddleware::LoudLogger if loud_logger
+        connection.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/instagram/error.rb

@@ -0,0 +1,34 @@
+module Instagram
+  # Custom error class for rescuing from all Instagram errors
+  class Error < StandardError; end
+
+  # Raised when Instagram returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Instagram returns the HTTP status code 403
+  class Forbidden < Error; end
+
+  # 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
+
+  # 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
+
+  # Raised when Instagram returns the HTTP status code 429
+  class RateLimitExceeded < Error; end
+end

data/lib/instagram/oauth.rb

@@ -0,0 +1,36 @@
+module Instagram
+  # Defines HTTP request methods
+  module OAuth
+    # Return URL for OAuth authorization
+    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
+
+    # 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), signature=false, raw=false, unformatted=true, no_response_wrapper=true)
+    end
+
+    private
+
+    def authorization_params
+      {
+        :client_id => client_id
+      }
+    end
+
+    def access_token_params
+      {
+        :client_id => client_id,
+        :client_secret => client_secret
+      }
+    end
+  end
+end

data/lib/instagram/request.rb

@@ -0,0 +1,83 @@
+require 'openssl'
+require 'base64'
+
+module Instagram
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={}, signature=false, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper(), signed=sign_requests)
+      request(:get, path, options, signature, raw, unformatted, no_response_wrapper, signed)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={}, signature=false, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper(), signed=sign_requests)
+      request(:post, path, options, signature, raw, unformatted, no_response_wrapper, signed)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={},  signature=false, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper(), signed=sign_requests)
+      request(:put, path, options, signature, raw, unformatted, no_response_wrapper, signed)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={}, signature=false, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper(), signed=sign_requests)
+      request(:delete, path, options, signature, raw, unformatted, no_response_wrapper, signed)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options, signature=false, raw=false, unformatted=false, no_response_wrapper=false, signed=sign_requests)
+      response = connection(raw).send(method) do |request|
+        path = formatted_path(path) unless unformatted
+
+        if signed == true
+          if client_id != nil
+            sig_options = options.merge({:client_id => client_id})
+          end
+          if access_token != nil
+            sig_options = options.merge({:access_token => access_token})
+          end
+          sig = generate_sig("/"+path, sig_options, client_secret)
+          options[:sig] = sig
+        end
+
+        case method
+        when :get, :delete
+          request.url(URI.encode(path), options)
+        when :post, :put
+          request.path = URI.encode(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
+      return Response.create( response.body, {:limit => response.headers['x-ratelimit-limit'].to_i,
+                                              :remaining => response.headers['x-ratelimit-remaining'].to_i} )
+    end
+
+    def formatted_path(path)
+      [path, format].compact.join('.')
+    end
+
+    def get_insta_fowarded_for(ips, secret)
+        digest = OpenSSL::Digest.new('sha256')
+        signature = OpenSSL::HMAC.hexdigest(digest, secret, ips)
+        return [ips, signature].join('|')
+    end
+
+    def generate_sig(endpoint, params, secret)
+      sig = endpoint
+      params = params.sort_by{|c|c[0].to_s}
+      params.map do |key, val|
+        sig += '|%s=%s' % [key, val]
+      end
+      digest = OpenSSL::Digest.new('sha256')
+      return OpenSSL::HMAC.hexdigest(digest, secret, sig)
+    end
+
+  end
+end

data/lib/instagram/response.rb

@@ -0,0 +1,22 @@
+module Instagram
+  module Response
+    def self.create( response_hash, ratelimit_hash )
+      response_hash = {} unless response_hash
+      data = response_hash.data.dup rescue response_hash
+      data.extend( self )
+      data.instance_exec do
+        %w{pagination meta}.each do |k|
+          response_hash.public_send(k).tap do |v|
+            instance_variable_set("@#{k}", v) if v
+          end
+        end
+        @ratelimit = ::Hashie::Mash.new(ratelimit_hash)
+      end
+      data
+    end
+
+    attr_reader :pagination
+    attr_reader :meta
+    attr_reader :ratelimit
+  end
+end

data/lib/instagram/version.rb

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

data/lib/instagram.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../instagram/error', __FILE__)
+require File.expand_path('../instagram/configuration', __FILE__)
+require File.expand_path('../instagram/api', __FILE__)
+require File.expand_path('../instagram/client', __FILE__)
+require File.expand_path('../instagram/response', __FILE__)
+
+module Instagram
+  extend Configuration
+
+  # Alias for Instagram::Client.new
+  #
+  # @return [Instagram::Client]
+  def self.client(options={})
+    Instagram::Client.new(options)
+  end
+
+  # Delegate to Instagram::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Instagram::Client
+  def self.respond_to?(method, include_all=false)
+    return client.respond_to?(method, include_all) || super
+  end
+end

data/spec/faraday/response_spec.rb

@@ -0,0 +1,101 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Faraday::Response do
+  before do
+    @client = Instagram::Client.new
+  end
+
+  {
+    400 => Instagram::BadRequest,
+    403 => Instagram::Forbidden,
+    404 => Instagram::NotFound,
+    429 => Instagram::TooManyRequests,
+    500 => Instagram::InternalServerError,
+    503 => Instagram::ServiceUnavailable
+  }.each do |status, exception|
+    context "when HTTP status is #{status}" do
+
+      before do
+        stub_get('users/self/feed.json').
+          to_return(:status => status)
+      end
+
+      it "should raise #{exception.name} error" do
+        expect do
+          @client.user_media_feed()
+        end.to raise_error(exception)
+      end
+
+    end
+  end
+
+  context "when a 400 is raised" do
+    before do
+      stub_get('users/self/feed.json').
+        to_return(:body => '{"meta":{"error_message": "Bad words are bad."}}', :status => 400)
+    end
+
+    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
+  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
+
+  context "when a 400 is raised with an HTML response" do
+    before do
+      stub_get('users/self/feed.json').to_return(
+        :body => '<html><body><h1>400 Bad Request</h1> The server returned an invalid or incomplete response. </body></html>',
+        :status => 400)
+    end
+
+    it "should return the body error type" do
+      expect do
+        @client.user_media_feed()
+      end.to raise_error(Instagram::BadRequest)
+    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
+      expect do
+        @client.user_media_feed()
+      end.to 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
+      expect do
+        @client.user_media_feed()
+      end.to raise_error(Instagram::GatewayTimeout)
+    end
+  end
+end