rgigya 1.0.2 → 1.1.0

data/rgigya.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rgigya"
-  s.version = "1.0.2"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Scott Sampson"]
-  s.date = "2013-04-17"
+  s.date = "2013-05-17"
   s.description = "This is a ruby SDK for the Gigya api."
   s.email = "scott@cloudspace.com"
   s.extra_rdoc_files = [
@@ -25,9 +25,14 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/rgigya.rb",
+    "lib/rgigya/base.rb",
+    "lib/rgigya/hash.rb",
+    "lib/rgigya/sig_utils.rb",
     "rgigya.gemspec",
     "spec/helpers.rb",
-    "spec/rgigya_spec.rb",
+    "spec/rgigya_secure_spec.rb",
+    "spec/rgigya_shared_examples.rb",
+    "spec/rgigya_signature_spec.rb",
     "spec/spec_helper.rb",
     "test/dummy/Gemfile",
     "test/dummy/Gemfile.lock",

data/spec/helpers.rb

@@ -5,4 +5,30 @@ module Helpers
     })
     return response['UID']
   end
+  
+  def sample_frends_json_data
+    return JSON('{
+            "friends": [{
+                "UID": "00",
+                "isSiteUser": false,
+                "isSiteUID": false,
+                "identities": [{
+                    "provider": "facebook",
+                    "providerUID": "00000",
+                    "isLoginIdentity": false,
+                    "nickname": "Baba",
+                    "photoURL": "http://profile.ak.fbcdn.net/hprofile-ak-snc4/00.jpg",
+                    "thumbnailURL": "http://profile.ak.fbcdn.net/hprofile-ak-snc4/00.jpg"}],
+                "nickname": "Baba",
+                "photoURL": "http://profile.ak.fbcdn.net/hprofile-ak-snc4/00.jpg",
+                "thumbnailURL": "http://profile.ak.fbcdn.net/hprofile-ak-snc4/00.jpg",
+                "signatureTimestamp": "11111111111",
+                "friendshipSignature": "kfwFFiXqP+NySU79E+CZY0Pu1Mc="
+            }],
+            "statusCode": 200,
+            "errorCode": 0,
+            "statusReason": "OK",
+            "callId": "e2b7c39de36541b4940087d66d4c1d77"
+        }')
+  end
 end

data/spec/rgigya_secure_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/rgigya_shared_examples.rb')
+
+describe "RGigyaSecure" do
+  before :each do
+    RGigya.config({
+      :api_key => GIGYA_API_KEY,
+      :api_secret => GIGYA_API_SECRET,
+      :use_ssl => true,
+      :domain => "us1"
+    })
+    @protocol = "https"
+    @method = "GET"
+  end
+  
+  
+  it_behaves_like RGigya
+end

data/spec/rgigya_shared_examples.rb

@@ -0,0 +1,315 @@
+shared_examples_for RGigya do
+  it "should use the socialize url when making a socialize api call" do
+    RGigya.stub(:required_parameters) {
+      ''
+    }
+    # we pass in the "_" replaced with "." already
+    url = RGigya.build_url("socialize.getUserInfo","#{@method}",{})
+    url.should match(/#{@protocol}:\/\/socialize.us1.gigya.com/)
+  end
+  
+  
+    
+    it "should use the gm url when making a game mechanic api call" do
+      RGigya.stub(:required_parameters) {
+        ''
+      }
+      # we pass in the "_" replaced with "." already
+      url = RGigya.build_url("gm.notifyAction","#{@method}",{})
+      url.should match(/#{@protocol}:\/\/gm.us1.gigya.com/)
+    end
+    
+    
+    it "should use the comments url when making a comment api call" do
+      RGigya.stub(:required_parameters) {
+        ''
+      }
+      # we pass in the "_" replaced with "." already
+      url = RGigya.build_url("comments.getTopStreams","#{@method}",{})
+      url.should match(/#{@protocol}:\/\/comments.us1.gigya.com/)
+    end
+    
+    it "should use the accounts url when making an accounts api call" do
+      RGigya.stub(:required_parameters) {
+        ''
+      }
+      # we pass in the "_" replaced with "." already
+      url = RGigya.build_url("accounts.getPolicies","#{@method}",{})
+      url.should match(/#{@protocol}:\/\/accounts.us1.gigya.com/)
+    end
+    
+    it "should use the reports url when making a reports api call" do
+      RGigya.stub(:required_parameters) {
+        ''
+      }
+      # we pass in the "_" replaced with "." already
+      url = RGigya.build_url("reports.getChatStats","#{@method}",{})
+      url.should match(/#{@protocol}:\/\/reports.us1.gigya.com/)
+    end
+    
+    
+    it "should use the chats url when making a chats api call" do
+      RGigya.stub(:required_parameters) {
+        ''
+      }
+      # we pass in the "_" replaced with "." already
+      url = RGigya.build_url("chat.getMessages","#{@method}",{})
+      url.should match(/#{@protocol}:\/\/chat.us1.gigya.com/)
+    end
+    
+    it "should use the ds url when making a data store api call" do
+      RGigya.stub(:required_parameters) {
+        ''
+      }
+      # we pass in the "_" replaced with "." already
+      url = RGigya.build_url("ds.get","#{@method}",{})
+      url.should match(/#{@protocol}:\/\/ds.us1.gigya.com/)
+    end
+    
+    
+    
+    it "should raise a bad param error if UID is nil" do
+      expect {
+        RGigya.build_url('socialize.getUserInfo', "#{@method}",{:uid => nil})
+      }.to raise_error(RGigya::UIDParamIsNil)
+    end
+    
+    it "should raise a bad param error if siteUID is nil" do
+      expect {
+        RGigya.build_url('socialize.getUserInfo', "#{@method}",{:siteUID => nil})
+      }.to raise_error(RGigya::SiteUIDParamIsNil)
+    end
+    
+    it "should fill in the required parameters on request" do
+      # we pass in the "_" replaced with "." already
+      params = RGigya.required_parameters
+      params.should match(/apiKey=#{Regexp.escape(CGI.escape(GIGYA_API_KEY))}/)
+      params.should match(/secret=#{Regexp.escape(CGI.escape(GIGYA_API_SECRET))}/)
+      params.should match(/format=json/)    
+    end
+    
+    it "should succeed with a result code of 0 from gigya" do 
+      params = RGigya.check_for_errors({'errorCode' => 0})
+      params.should have_key('errorCode')
+    end
+    
+    
+    it "should return nil and not raise an error with a limit reached error" do 
+      results = RGigya.check_for_errors({'errorCode' => 400124})
+      results.should be_nil
+    end
+    
+    it "should raise an error when we pass in a bad parameter" do
+      expect {
+        RGigya.check_for_errors({
+          'errorCode' => 400002
+        })
+      }.to raise_error(RGigya::BadParamsOrMethodName)
+    end
+    
+    it "should raise an error when an errorcode other than 0,400002, or 400124 is returned" do
+      # Buffering the log
+      buffer = StringIO.new
+      $stdout = buffer
+      expect {
+        RGigya.check_for_errors({
+          'errorCode' => 4034934
+        })
+      }.to raise_error(RGigya::ErrorCodeReturned)
+      $stdout = STDOUT
+    end
+    
+    it "should report method missing if method does not start with socialize" do
+      expect {
+        RGigya.method_missing(:abc,{})
+      }.to raise_error(NameError)
+    end
+    
+    
+    it "should report method missing if method does not start with gm" do
+      expect {
+        RGigya.method_missing(:abc,{})
+      }.to raise_error(NameError)
+    end
+    
+    
+    it "should report method missing if method does not start with socialize,gm, accounts,reports, chat,ds or comments" do
+      expect {
+        RGigya.method_missing(:abc,{})
+      }.to raise_error(NameError)
+    end
+    
+    it "should not respond to method starting without socialize,gm, accounts,reports, chat,ds or comments" do
+      RGigya.respond_to?(:abc,false).should be_false
+    end
+    
+    it "should respond to method starting with socialize" do
+      RGigya.respond_to?(:socialize_getUserInfo,false).should be_true
+    end
+    
+    
+    it "should respond to method starting with gm" do
+      RGigya.respond_to?(:gm_notifyAction,false).should be_true
+    end
+    
+    it "should respond_to method starting with comments" do
+      RGigya.respond_to?(:comments_getComments,false).should be_true
+    end
+    
+    it "should respond_to method starting with accounts" do
+      RGigya.respond_to?(:accounts_getPolicies,false).should be_true
+    end
+    
+    it "should respond_to method starting with reports" do
+      RGigya.respond_to?(:reports_getChatStats,false).should be_true
+    end
+    
+    it "should respond_to method starting with chat" do
+      RGigya.respond_to?(:chat_getMessages,false).should be_true
+    end
+    
+    it "should respond_to method starting with ds" do
+      RGigya.respond_to?(:ds_get,false).should be_true
+    end
+    
+    
+    it "should print log to standard out" do
+      str = "This should print to the screen"
+      buffer = StringIO.new
+      $stdout = buffer
+      RGigya.log(str)
+      $stdout = STDOUT
+      buffer.rewind
+      buffer.read.should == str + "\n"
+    end
+    
+    
+    it "should print log to standard out" do
+      # buffer the input and check
+      str = "This should print to the screen"
+      buffer = StringIO.new
+      $stdout = buffer
+      RGigya.log(str)
+      $stdout = STDOUT
+      buffer.rewind
+      buffer.read.should == str + "\n"
+    end
+    
+    
+    it "should log to the Rails log if rails exists" do
+      # Mock and Stub Rails.logger.info
+      Rails = mock("Rails")
+      Rails.stub(:logger) {  
+        logger = mock("Logger");
+        logger.stub(:info) do |str|
+          puts "mocked_data=#{str}"
+        end
+        logger
+      }
+      
+      # buffer the input and check
+      str = "This should print to the screen"
+      buffer = StringIO.new
+      $stdout = buffer
+      RGigya.log(str)
+      $stdout = STDOUT
+      buffer.rewind
+      buffer.read.should == "mocked_data=" + str + "\n"
+      # Remove the rails object so it doesn't interfere with tests below
+      Object.send(:remove_const, :Rails)
+    end
+      
+    it "should return a result of false if we pass a bad method" do
+      HTTParty.stub(:get) do |url,options|
+        nil
+      end
+      
+      RGigya.parse_results("socialize_notAMethod",{}).should be_false
+    end
+      
+    it "should raise json error if gigya returns bad json" do
+      HTTParty.stub(:get) do |url,options|
+        Response = mock("Response")
+        Response.stub(:body) {
+          '{'
+        }
+        Response
+      end
+      HTTParty.stub(:post) do |url,options|
+        Response = mock("Response")
+        Response.stub(:body) {
+          '{'
+        }
+        Response
+      end
+      
+      
+      expect {
+        RGigya.parse_results("socialize_notAMethod",{}).should be_false
+      }.to raise_error(RGigya::JSONParseError)
+    end
+      
+       
+    it "should raise a response error if the gigya call fails" do
+      HTTParty.stub(:get) do |url,options|
+        raise SocketError
+      end
+      HTTParty.stub(:post) do |url,options|
+        raise SocketError
+      end
+      
+      expect {
+        RGigya.parse_results("socialize_notAMethod",{}).should be_false
+      }.to raise_error(RGigya::ResponseError)    
+    end
+    
+    it "should raise a response error if the gigya call times out" do
+      HTTParty.stub(:get) do |url,options|
+        raise Timeout::Error
+      end
+      HTTParty.stub(:post) do |url,options|
+        raise Timeout::Error
+      end
+      
+      expect {
+        RGigya.parse_results("socialize_notAMethod",{}).should be_false
+      }.to raise_error(RGigya::ResponseError)
+      
+    end
+    
+    
+    # Actual tests that modify the gigya account below
+    
+    it "should login a user" do
+      
+      userInfo = {
+        'nickname' => 'Gigems', 
+        'email' => 'ralph@cloudspace.com',
+        'firstName' => 'Ralph', 
+        'lastName' => 'Masterson'
+      }
+      
+      response = RGigya.socialize_notifyLogin({
+        :siteUID => '1',
+        :userInfo => userInfo.to_json
+      })
+    end
+    
+    it "should register a user" do
+      uid = get_uid
+      RGigya.socialize_notifyRegistration({
+        :UID => uid,
+        :siteUID => '1',
+      })
+      
+    end
+    
+    it "should get the users info", :user_info => true do
+      uid = get_uid
+      response = RGigya.socialize_getUserInfo({
+        'UID' => uid,
+      })
+      response['nickname'].should match 'Gigems'
+    end
+  
+end

data/spec/rgigya_signature_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/rgigya_shared_examples.rb')
+
+describe "RGigyaSignature" do
+  before :each do
+    RGigya.config({
+      :api_key => GIGYA_API_KEY,
+      :api_secret => GIGYA_API_SECRET,
+      :use_ssl => false,
+      :domain => "us1"
+    })
+    @protocol = "http"
+    @method = "POST"
+  end
+  
+  
+  it_behaves_like RGigya
+  
+  it "should verify signature after successful login" do
+    userInfo = {
+      'nickname' => 'Gigems', 
+      'email' => 'ralph@cloudspace.com',
+      'firstName' => 'Ralph', 
+      'lastName' => 'Masterson'
+    }
+    
+    response = RGigya.socialize_notifyLogin({
+      :siteUID => '1',
+      :userInfo => userInfo.to_json
+    })
+    
+    RGigya::SigUtils::validate_user_signature(response['UID'], response['signatureTimestamp'], response['UIDSignature']).should be_true
+    
+  end
+  
+  # Note:  I stub everything here including the signature so this test really isn't valid
+  # But, it explains how it works
+  it "should verify friends signature after successful api call" do    
+    RGigya.stub(:socialize_getFriendsInfo) do |url,options|
+      # this method is in helpers.rb
+      sample_frends_json_data
+    end
+    
+    response = RGigya.socialize_getFriendsInfo({
+      :uid => '1',
+      :signIDs => true
+    })
+    
+    friend = response['friends'].first
+    
+    RGigya::SigUtils::validate_friend_signature("1", friend['signatureTimestamp'], friend['UID'], friend['friendshipSignature']).should be_true
+  end
+  
+  
+  # Not much of test here because the signature always change
+  # Lets just run it to make sure its not throwing any errors
+  it "should return the value for the dynamic session cookie" do        
+    two_hours_from_now = (Time.now + (60*60*2)).utc.strftime("%s").to_i
+    RGigya::SigUtils::get_dynamic_session_signature("111111111", two_hours_from_now).should_not == ""
+  end
+  
+end

data/spec/spec_helper.rb

@@ -4,9 +4,8 @@ RSpec.configure do |config|
   # some (optional) config here
   config.include Helpers
   
-  
-  # these need to be filled out for tests to work
-  GIGYA_API_KEY = "<add api key here>"
-  GIGYA_API_SECRET = "<add api secret here>"
-  
+  # To verify Values
+  # GIGYA_API_KEY = "<add api key here>"
+  # GIGYA_API_SECRET = "<add api secret here>"
+
 end

data/test/dummy/Gemfile

@@ -9,7 +9,6 @@ gem 'sqlite3'
 
 gem 'rgigya'
 
-
 # Gems used only for assets and not required
 # in production environments by default.
 group :assets do

data/test/dummy/Gemfile.lock

@@ -49,13 +49,12 @@ GEM
     jquery-rails (2.2.1)
       railties (>= 3.0, < 5.0)
       thor (>= 0.14, < 2.0)
-    json (1.7.7)
-    mail (2.5.3)
-      i18n (>= 0.4.0)
+    json (1.8.0)
+    mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.22)
-    multi_json (1.7.2)
+    mime-types (1.23)
+    multi_json (1.7.3)
     multi_xml (0.5.3)
     polyglot (0.3.3)
     rack (1.4.5)
@@ -83,9 +82,9 @@ GEM
     rake (10.0.4)
     rdoc (3.12.2)
       json (~> 1.4)
-    rgigya (0.1.0)
+    rgigya (1.0.2)
       httparty (~> 0.11.0)
-    sass (3.2.7)
+    sass (3.2.9)
     sass-rails (3.2.6)
       railties (~> 3.2.0)
       sass (>= 3.1.10)
@@ -97,12 +96,12 @@ GEM
       tilt (~> 1.1, != 1.3.0)
     sqlite3 (1.3.7)
     thor (0.18.1)
-    tilt (1.3.7)
+    tilt (1.4.1)
     treetop (1.4.12)
       polyglot
       polyglot (>= 0.3.1)
     tzinfo (0.3.37)
-    uglifier (2.0.1)
+    uglifier (2.1.0)
       execjs (>= 0.3.0)
       multi_json (~> 1.0, >= 1.0.2)
 

data/test/dummy/config/environments/development.rb

@@ -38,5 +38,9 @@ end
 
 
 # The Gigya api key and secret need to be set here
-GIGYA_API_KEY = "<add api key here>"
-GIGYA_API_SECRET = "<add api secret here>"
+RGigya.config({
+  :api_key => "<add api key here>",
+  :api_secret => "<add api secret here>",
+  :use_ssl => false,
+  :domain => "us1"
+})