instagram-community-maintained 1.1.6

data/lib/faraday/loud_logger.rb

@@ -0,0 +1,75 @@
+require 'faraday'
+
+# @private
+module FaradayMiddleware
+  # @private
+  class LoudLogger < Faraday::Middleware
+      extend Forwardable
+      def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+
+      def initialize(app, options = {})
+        @app = app
+        @logger = options.fetch(:logger) {
+          require 'logger'
+          ::Logger.new($stdout)
+        }
+      end
+
+      def call(env)
+        start_time = Time.now
+        info  { request_info(env) }
+        debug { request_debug(env) }
+        @app.call(env).on_complete do
+          end_time = Time.now
+          response_time = end_time - start_time
+          info  { response_info(env, response_time) }
+          debug { response_debug(env) }
+        end
+      end
+
+      private
+
+      def filter(output)
+        if ENV['INSTAGRAM_GEM_REDACT']
+          output = output.to_s.gsub(/client_id=[a-zA-Z0-9]*/,'client_id=[CLIENT-ID]')
+          output = output.to_s.gsub(/access_token=[a-zA-Z0-9]*/,'access_token=[ACCESS-TOKEN]')
+        else
+          output
+        end
+      end
+
+      def request_info(env)
+        "Started %s request to: %s" % [ env[:method].to_s.upcase, filter(env[:url]) ]
+      end
+
+      def response_info(env, response_time)
+        "Response from %s; Status: %d; Time: %.1fms" % [ filter(env[:url]), env[:status], (response_time * 1_000.0) ]
+      end
+
+      def request_debug(env)
+        debug_message("Request", env[:request_headers], env[:body])
+      end
+
+      def response_debug(env)
+        debug_message("Response", env[:response_headers], env[:body])
+      end
+
+      def debug_message(name, headers, body)
+        <<-MESSAGE.gsub(/^ +([^ ])/m, '\\1')
+        #{name} Headers:
+        ----------------
+        #{format_headers(headers)}
+
+        #{name} Body:
+        -------------
+        #{filter(body)}
+        MESSAGE
+      end
+
+      def format_headers(headers)
+        length = headers.map {|k,v| k.to_s.size }.max
+        headers.map { |name, value| "#{name.to_s.ljust(length)} : #{filter(value)}" }.join("\n")
+      end
+
+  end
+end

data/lib/faraday/oauth2.rb

@@ -0,0 +1,42 @@
+require 'faraday'
+
+# @private
+module FaradayMiddleware
+  # @private
+  class InstagramOAuth2 < Faraday::Middleware
+    def call(env)
+
+      if env[:method] == :get or env[:method] == :delete
+        if env[:url].query.nil?
+          query = {}
+        else
+          query = Faraday::Utils.parse_query(env[:url].query)
+        end
+
+        if @access_token and not query["client_secret"]
+          env[:url].query = Faraday::Utils.build_query(query.merge(:access_token => @access_token))
+          env[:request_headers] = env[:request_headers].merge('Authorization' => "Token token=\"#{@access_token}\"")
+        elsif @client_id
+          env[:url].query = Faraday::Utils.build_query(query.merge(:client_id => @client_id))
+        end
+      else
+        if @access_token and not env[:body] && env[:body][:client_secret]
+          env[:body] = {} if env[:body].nil?
+          env[:body] = env[:body].merge(:access_token => @access_token)
+          env[:request_headers] = env[:request_headers].merge('Authorization' => "Token token=\"#{@access_token}\"")
+        elsif @client_id
+          env[:body] = env[:body].merge(:client_id => @client_id)
+        end
+      end
+
+
+      @app.call env
+    end
+
+    def initialize(app, client_id, access_token=nil)
+      @app = app
+      @client_id = client_id
+      @access_token = access_token
+    end
+  end
+end

data/lib/faraday/raise_http_exception.rb

@@ -0,0 +1,59 @@
+require 'faraday'
+
+# @private
+module FaradayMiddleware
+  # @private
+  class RaiseHttpException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response[:status].to_i
+        when 400
+          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
+          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
+
+    def initialize(app)
+      super app
+      @parser = nil
+    end
+
+    private
+
+    def error_message_400(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{error_body(response[:body])}"
+    end
+
+    def error_body(body)
+      # body gets passed as a string, not sure if it is passed as something else from other spots?
+      if not body.nil? and not body.empty? and body.kind_of?(String)
+        # removed multi_json thanks to wesnolte's commit
+        body = ::JSON.parse(body)
+      end
+
+      if body.nil?
+        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
+
+    def error_message_500(response, body=nil)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{[response[:status].to_s + ':', body].compact.join(' ')}"
+    end
+  end
+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/lib/instagram/api.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+require File.expand_path('../oauth', __FILE__)
+
+module Instagram
+  # @private
+  class API
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = Instagram.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      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
+  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/client/comments.rb

@@ -0,0 +1,62 @@
+module Instagram
+  class Client
+    # Defines methods related to comments
+    module Comments
+      # Returns a list of comments for a given media item ID
+      #
+      # @overload media_comments(id)
+      #   @param id [Integer] An Instagram media item ID
+      #   @return [Hashie::Mash] The requested comments.
+      #   @example Returns a list of comments for the media item of ID 1234
+      #     Instagram.media_comments(777)
+      # @format :json
+      # @authenticated true
+      #
+      #   If getting this data of a protected user, you must be authenticated (and be allowed to see that user).
+      # @rate_limited true
+      # @see http://instagram.com/developer/endpoints/comments/#get_media_comments
+      def media_comments(id, *args)
+        response = get("media/#{id}/comments")
+        response
+      end
+
+      # Creates a comment for a given media item ID
+      #
+      # @overload create_media_comment(id, text)
+      #   @param id [Integer] An Instagram media item ID
+      #   @param text [String] The text of your comment
+      #   @return [Hashie::Mash] The comment created.
+      #   @example Creates a new comment on media item with ID 777
+      #     Instagram.create_media_comment(777, "Oh noes!")
+      # @format :json
+      # @authenticated true
+      #
+      #   If getting this data of a protected user, you must be authenticated (and be allowed to see that user).
+      # @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), signature=true)
+        response
+      end
+
+      # Deletes a comment for a given media item ID
+      #
+      # @overload delete_media_comment(media_id, comment_id)
+      #   @param media_id [Integer] An Instagram media item ID.
+      #   @param comment_id [Integer] Your comment ID of the comment you wish to delete.
+      #   @return [nil]
+      #   @example Delete the comment with ID of 1234, on the media item with ID of 777
+      #     Instagram.delete_media_comment(777, 1234)
+      # @format :json
+      # @authenticated true
+      #
+      #   In order to remove a comment, you must be the owner of the comment, the media item, or both.
+      # @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, signature=true)
+        response
+      end
+    end
+  end
+end

data/lib/instagram/client/embedding.rb

@@ -0,0 +1,28 @@
+module Instagram
+  class Client
+  	# Defines methods related to embedding
+    module Embedding
+    	# Returns information about the media associated with the given short link
+      #
+	    # @overload oembed(url=nil, options={})
+	    # 	@param url [String] An instagram short link
+	    #   @param options [Hash] A customizable set of options
+	    #   @option options [Integer] :maxheight Maximum height of returned media
+	    #   @option options [Integer] :maxwidth Maximum width of returned media
+	    #   @option options [Integer] :callback A JSON callback to be invoked
+	    #   @return [Hashie::Mash] Information about the media associated with given short link
+      # 	@example Return information about the media associated with http://instagr.am/p/BUG/
+      #   	Instagram.oembed(http://instagr.am/p/BUG/)
+      #
+      # @see http://instagram.com/developer/embedding/#oembed
+      # @format :json
+      # @authenticated false
+      # @rate_limited true
+      def oembed(*args)
+        url = args.first
+        return nil unless url
+        get("oembed?url=#{url}", {}, false, false, true)
+      end
+    end
+  end
+end

data/lib/instagram/client/geographies.rb

@@ -0,0 +1,29 @@
+module Instagram
+  class Client
+    # Defines methods related to real-time geographies
+    module Geographies
+      # Returns a list of recent media items for a given real-time geography
+      #
+      # @overload geography_recent_media(id, options={})
+      #   @param user [Integer] A geography ID from a real-time subscription.
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [Integer] :count (nil) Limit the number of results returned
+      #   @option options [Integer] :min_id (nil) Return media before this min_id
+      #   @option options [Integer] :max_id (nil) Return media after this max_id
+      #   @option options [Integer] :min_timestamp (nil) Return media after this UNIX timestamp
+      #   @option options [Integer] :max_timestamp (nil) Return media before this UNIX timestamp
+      #   @return [Hashie::Mash]
+      #   @example Return a list of the most recent media items taken within a specific geography
+      #     Instagram.geography_recent_media(514276)
+      # @see http://instagram.com/developer/endpoints/geographies/
+      # @format :json
+      # @authenticated false
+      # @rate_limited true
+      def geography_recent_media(id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = get("geographies/#{id}/media/recent", options)
+        response
+      end
+    end
+  end
+end

data/lib/instagram/client/likes.rb

@@ -0,0 +1,58 @@
+module Instagram
+  class Client
+    # Defines methods related to likes
+    module Likes
+      # Returns a list of users who like a given media item ID
+      #
+      # @overload media_likes(id)
+      #   @param media [Integer] An Instagram media item ID
+      #   @return [Hashie::Mash] A list of users.
+      #   @example Returns a list of users who like the media item of ID 1234
+      #     Instagram.media_likes(777)
+      # @format :json
+      # @authenticated true
+      #
+      #   If getting this data of a protected user, you must be authenticated (and be allowed to see that user).
+      # @rate_limited true
+      # @see http://instagram.com/developer/endpoints/likes/#get_media_likes
+      def media_likes(id, *args)
+        response = get("media/#{id}/likes")
+        response
+      end
+
+      # Issues a like by the currently authenticated user, for a given media item ID
+      #
+      # @overload like_media(id, text)
+      #   @param id [Integer] An Instagram media item ID
+      #   @return [Hashie::Mash] Metadata
+      #   @example Like media item with ID 777
+      #     Instagram.like_media(777)
+      # @format :json
+      # @authenticated true
+      #
+      #   If getting this data of a protected user, you must be authenticated (and be allowed to see that user).
+      # @rate_limited true
+      # @see http://instagram.com/developer/endpoints/likes/#post_likes
+      def like_media(id, options={})
+        response = post("media/#{id}/likes", options, signature=true)
+        response
+      end
+
+      # Removes the like on a givem media item ID for the currently authenticated user
+      #
+      # @overload unlike_media(id)
+      #   @param media_id [Integer] An Instagram media item ID.
+      #   @return [Hashie::Mash] Metadata
+      #   @example Remove the like for the currently authenticated user on the media item with the ID of 777
+      #     Instagram.unlike_media(777)
+      # @format :json
+      # @authenticated true
+      # @rate_limited true
+      # @see http://instagram.com/developer/endpoints/likes/#delete_likes
+      def unlike_media(id, options={})
+        response = delete("media/#{id}/likes", options, signature=true)
+        response
+      end
+    end
+  end
+end

data/lib/instagram/client/locations.rb

@@ -0,0 +1,75 @@
+module Instagram
+  class Client
+    # Defines methods related to media items
+    module Locations
+      # Returns extended information of a given Instagram location
+      #
+      # @overload location(id)
+      #   @param location [Integer] An Instagram location ID
+      #   @return [Hashie::Mash] The requested location.
+      #   @example Return extended information for the Instagram office
+      #     Instagram.location(514276)
+      # @format :json
+      # @authenticated false
+      # @rate_limited true
+      # @see http://instagram.com/developer/endpoints/locations/#get_locations
+      def location(id, *args)
+        response = get("locations/#{id}")
+        response
+      end
+
+      # Returns a list of recent media items for a given Instagram location
+      #
+      # @overload location_recent_media(id, options={})
+      #   @param user [Integer] An Instagram location ID.
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [Integer] :max_timestamp (nil) Return media before this UNIX timestamp
+      #   @option options [Integer] :max_id (nil) Returns results with an ID less than (that is, older than) or equal to the specified ID.
+      #   @option options [Integer] :count (nil) Limits the number of results returned per page.
+      #   @return [Hashie::Mash]
+      #   @example Return a list of the most recent media items taken at the Instagram office
+      #     Instagram.location_recent_media(514276)
+      # @see http://instagram.com/developer/endpoints/locations/#get_locations_media_recent
+      # @format :json
+      # @authenticated false
+      # @rate_limited true
+      def location_recent_media(id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = get("locations/#{id}/media/recent", options)
+        response
+      end
+
+      # Returns Instagram locations within proximity of given lat,lng or foursquare venue id
+      #
+      # @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 [Hashie::Mash] location resultm object, #data is an 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 http://instagram.com/developer/endpoints/locations/#get_locations_search
+      # @format :json
+      # @authenticated false
+      # @rate_limited true
+      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))
+        when 3
+          lat, lng, distance = args
+          response = get('locations/search', options.merge(:lat => lat, :lng => lng, :distance => distance))
+        end
+        response
+      end
+    end
+  end
+end