instagram 1.1.4 → 1.1.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    M2Y3MDRiMGZmYTMzMzk1MDVkYTc3MGRjYTBjNWM5ZjFhMjY5NDA4Zg==
+    YTgwYTQ4MzU4NDI1ZmI4ZTM0MGNmZDIxM2I3ZTI3YWMyMDAyNDFlYg==
   data.tar.gz: !binary |-
-    ZTY4N2RkYzBmYTdkNWZlM2ExNTgzN2FjNzhmYWQ5OGU3YjA0M2JiYg==
+    YTdiYWFiNTliYjdlNzAyMjdhMGE1YThmNjFjNmE1YjdkZjgyY2NhZA==
 SHA512:
   metadata.gz: !binary |-
-    NjY2Nzg2MjM1YmIwYTM5MDVjYzRiMmZlNDdlNDY1YWFlYzZhN2ExMWE2NDZm
-    NTI0NzIxNDkxMTNiMWIxYWMyZGMzZjE1ZGYxOWM2YWQ1MGQ3ZWEwMzJmZWU3
-    NjJmMGEzMWY5YTUyZGQwOGIxZGIyOWZmNDk0ZjhiMDU3N2QwYjY=
+    ZTFjM2ViODI3NGE4ZTk4ZTM3Y2FlOTM3Nzk4MjFlYzgwYjEyMTE2YWUyODIz
+    MzY2ZmNhMTJlNzdhNWE3ZGY1NDkwMzIxNzJmYjI1ZWEzNWM2ZGIxZmI1ZTJi
+    MjJhYzVlZGQ4ZDVjYjE0OTQ4ZmMzNWQyOWZiOTQ4M2EyOTQwZDg=
   data.tar.gz: !binary |-
-    ZmZhOTBhYTRiODQ1ZjE5ODZjM2RlN2IwYzBjMWM5NDUxMGQwYmM5MmQ3YWEx
-    YjQ5YzRjMTFjODUxOTVmNGE0ZGMyMDNjNzVlMWY0NmNlYTAzYjM2MzBhY2Vi
-    ODE3YTljY2ViYjdiZmZlNzRjNGM0YmUwMmRhZWE3MTAzYTcwYjc=
+    MzhlODQzNzE2YjJjZTllMGRkNGIxNTg4NjAyMWFkOTZmYjgyY2U2ZWQzZjY2
+    ZGNkMGQ1MmQwNmI1NjcxMDY5ODczNjE0YTA1MDJlZGRkYTlmNDZjZWIwODQz
+    MTBmNjczNjBjOWE4MTBkMGM5ZGIxN2ZkNmYzNzc3YjcyMTJmZDE=

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/instagram/configuration.rb

@@ -18,7 +18,8 @@ module Instagram
       :format,
       :proxy,
       :user_agent,
-      :no_response_wrapper
+      :no_response_wrapper,
+      :loud_logger,
     ].freeze
 
     # By default, don't set a user access token
@@ -72,6 +73,9 @@ module Instagram
     VALID_FORMATS = [
       :json].freeze
 
+    # By default, don't turn on loud logging
+    DEFAULT_LOUD_LOGGER = nil
+
     # @private
     attr_accessor *VALID_OPTIONS_KEYS
 
@@ -107,6 +111,7 @@ module Instagram
       self.proxy              = DEFAULT_PROXY
       self.user_agent         = DEFAULT_USER_AGENT
       self.no_response_wrapper= DEFAULT_NO_RESPONSE_WRAPPER
+      self.loud_logger        = DEFAULT_LOUD_LOGGER
     end
   end
 end

data/lib/instagram/connection.rb

@@ -23,6 +23,7 @@ module Instagram
           end
         end
         connection.use FaradayMiddleware::RaiseHttpException
+        connection.use FaradayMiddleware::LoudLogger if loud_logger
         connection.adapter(adapter)
       end
     end

data/lib/instagram/request.rb

@@ -5,31 +5,43 @@ 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())
-      request(:get, path, options, signature, raw, unformatted, no_response_wrapper)
+    def get(path, options={}, signature=false, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper(), signed=false)
+      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())
-      request(:post, path, options, signature, raw, unformatted, no_response_wrapper)
+    def post(path, options={}, signature=false, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper(), signed=false)
+      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())
-      request(:put, path, options, signature, raw, unformatted, no_response_wrapper)
+    def put(path, options={},  signature=false, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper(), signed=false)
+      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())
-      request(:delete, path, options, signature, raw, unformatted, no_response_wrapper)
+    def delete(path, options={}, signature=false, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper(), signed=false)
+      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)
+    def request(method, path, options, signature=false, raw=false, unformatted=false, no_response_wrapper=false, signed=false)
       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(path, options)
@@ -57,5 +69,14 @@ module Instagram
         return [ips, signature].join('|')
     end
 
+    def generate_sig(endpoint, params, secret)
+      sig = endpoint
+      params.sort.map do |key, val|
+        sig += '|%s=%s' % [key, val]
+      end
+      digest = OpenSSL::Digest::Digest.new('sha256')
+      return OpenSSL::HMAC.hexdigest(digest, secret, sig)
+    end
+
   end
 end

data/lib/instagram/version.rb

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

data/spec/instagram/api_spec.rb

@@ -43,6 +43,7 @@ describe Instagram::API do
           :scope => 'comments relationships',
           :user_agent => 'Custom User Agent',
           :no_response_wrapper => true,
+          :loud_logger => true,
         }
       end
 
@@ -213,5 +214,71 @@ describe Instagram::API do
           should have_been_made
       end
     end
+
+    describe "loud_logger param" do
+
+      before do
+        @client = Instagram::Client.new(:loud_logger => true)
+      end
+
+      context "outputs to STDOUT with faraday logs when enabled" do
+        before do
+          stub_get('users/self/feed.json').
+          to_return(:body => fixture("user_media_feed.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+        end
+
+        it "should return the body error message" do
+          output = capture_output do
+            @client.user_media_feed()
+          end
+
+          expect(output).to include 'INFO -- : Started GET request to: https://api.instagram.com/v1/users/self/feed.json'
+          expect(output).to include 'DEBUG -- : Response Headers:'
+          expect(output).to include "User-Agent : Instagram Ruby Gem #{Instagram::VERSION}"
+          expect(output).to include 'http://distillery.s3.amazonaws.com/media/2011/01/31/0f8e832c3dc6420bb6ddf0bd09f032f6_6.jpg'
+        end
+      end
+
+      context "shows STDOUT output when errors occur" 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
+          output = capture_output do
+            @client.user_media_feed() rescue nil
+          end
+
+          expect(output).to include 'INFO -- : Started GET request to: https://api.instagram.com/v1/users/self/feed.json'
+          expect(output).to include 'DEBUG -- : Response Headers:'
+          expect(output).to include "User-Agent : Instagram Ruby Gem #{Instagram::VERSION}"
+          expect(output).to include '{"meta":{"error_message": "Bad words are bad."}}'
+        end
+      end
+
+      context "will redact API keys if INSTAGRAM_GEM_REDACT=true" do
+        before do
+          stub_get('users/self/feed.json').
+          to_return(:body => fixture("user_media_feed.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+        end
+
+        it "should redact API keys" do
+          ENV.stub(:[]).with('http_proxy').and_return(nil)
+          ENV.stub(:[]).with('INSTAGRAM_GEM_REDACT').and_return('true')
+
+          output = capture_output do
+            @client.user_media_feed()
+          end
+
+          expect(output).to include 'INFO -- : Started GET request to: https://api.instagram.com/v1/users/self/feed.json'
+          expect(output).to include 'DEBUG -- : Response Headers:'
+          expect(output).to include "User-Agent : Instagram Ruby Gem #{Instagram::VERSION}"
+          expect(output).to include 'http://distillery.s3.amazonaws.com/media/2011/01/31/0f8e832c3dc6420bb6ddf0bd09f032f6_6.jpg'
+          expect(output).to include 'access_token=[ACCESS-TOKEN]'
+        end
+      end
+    end
   end
 end

data/spec/instagram_spec.rb

@@ -81,6 +81,19 @@ describe Instagram do
     end
   end
 
+    describe ".loud_logger" do
+    it "should return the loud_logger status" do
+      Instagram.loud_logger.should == nil
+    end
+  end
+
+  describe ".loud_logger=" do
+    it "should set the loud_logger" do
+      Instagram.loud_logger = true
+      Instagram.loud_logger.should == true
+    end
+  end
+
   describe ".configure" do
 
     Instagram::Configuration::VALID_OPTIONS_KEYS.each do |key|

data/spec/spec_helper.rb

@@ -18,6 +18,18 @@ RSpec.configure do |config|
   config.include WebMock::API
 end
 
+def capture_output(&block)
+  begin
+    old_stdout = $stdout
+    $stdout = StringIO.new
+    block.call
+    result = $stdout.string
+  ensure
+    $stdout = old_stdout
+  end
+  result
+end
+
 def a_delete(path)
   a_request(:delete, Instagram.endpoint + path)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instagram
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Shayne Sweeney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -157,6 +157,7 @@ files:
 - README.md
 - Rakefile
 - instagram.gemspec
+- lib/faraday/loud_logger.rb
 - lib/faraday/oauth2.rb
 - lib/faraday/raise_http_exception.rb
 - lib/instagram.rb