instagram 0.6 → 0.6.1

data/instagram.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('faraday_middleware', '~> 0.3.1')
   s.add_runtime_dependency('multi_json', '~> 0.0.5')
   s.add_runtime_dependency('hashie', '~> 1.0.0')
+  s.add_runtime_dependency('ruby-hmac', '~> 0.4.0')
   s.authors = ["Shayne Sweeney"]
   s.description = %q{A Ruby wrapper for the Instagram REST and Search APIs}
   s.post_install_message =<<eos

data/lib/instagram/client/subscriptions.rb

@@ -1,3 +1,5 @@
+require 'hmac-sha1'
+
 module Instagram
   class Client
     # Defines methods related to real-time
@@ -98,6 +100,7 @@ module Instagram
       # @overload process_subscription(json, &block)
       #   @param json [String] The JSON response received by the Instagram real-time server
       #   @param block [Proc] A callable in which callbacks are defined
+      #   @option options [String] :signature Pass in an X-Hub-Signature to use for payload validation
       #   @return [nil]
       #   @example Process and handle a notification for a user media change
       #     Instagram.process_subscription(params[:body]) do |handler|
@@ -117,8 +120,20 @@ module Instagram
       #   Requires client_secret to be set on the client or passed in options
       # @rate_limited true
       # @see https://api.instagram.com/developer/realtime/
-      def process_subscription(json, &block)
+      def process_subscription(json, options={}, &block)
         raise ArgumentError, "callbacks block expected" unless block_given?
+
+        if options[:signature]
+          if !client_secret
+            raise ArgumentError, "client_secret must be set during configure"
+          end
+          verify_signature = HMAC::SHA1.hexdigest(client_secret, json)
+
+          if options[:signature] != verify_signature
+            raise Instagram::InvalidSignature, "invalid X-Hub-Signature does not match verify signature against client_secret"
+          end
+        end
+
         payload = MultiJson.decode(json)
         @changes = Hash.new { |h,k| h[k] = [] }
         for change in payload

data/lib/instagram/error.rb

@@ -13,4 +13,7 @@ module Instagram
 
   # Raised when Instagram returns the HTTP status code 503
   class ServiceUnavailable < Error; end
+
+  # Raised when a subscription payload hash is invalid
+  class InvalidSignature < Error; end
 end

data/lib/instagram/version.rb

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

data/spec/instagram/client/subscriptions_spec.rb

@@ -113,6 +113,36 @@ describe Instagram::Client do
           end
         end
       end
+
+      context "with a valid signature" do
+
+        before do
+          @json = fixture("subscription_payload.json").read
+        end
+
+        it "should not raise an Instagram::InvalidSignature error" do
+          lambda do
+            @client.process_subscription(@json, :signature => "f1dbe2b6184ac2131209c87bba8e0382d089a8a2") do |handler|
+              # hi
+            end
+          end.should_not raise_error(Instagram::InvalidSignature)
+        end
+      end
+
+      context "with an invalid signature" do
+
+        before do
+          @json = fixture("subscription_payload.json").read
+        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)
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,11 @@
 require 'simplecov'
 SimpleCov.start do
-  add_group 'Instagram', 'lib/Instagram'
+  add_group 'Instagram', 'lib/instagram'
   add_group 'Faraday Middleware', 'lib/faraday'
   add_group 'Specs', 'spec'
 end
 
-require File.expand_path('../../lib/Instagram', __FILE__)
+require File.expand_path('../../lib/instagram', __FILE__)
 
 require 'rspec'
 require 'webmock/rspec'

metadata

@@ -5,7 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  version: "0.6"
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Shayne Sweeney
@@ -13,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-24 00:00:00 -08:00
+date: 2011-03-04 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -174,6 +175,21 @@ dependencies:
         version: 1.0.0
   type: :runtime
   version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: ruby-hmac
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id012
 description: A Ruby wrapper for the Instagram REST and Search APIs
 email: 
 - shayne@instagr.am