reward_station 0.0.2 → 0.0.3

data/README.md

@@ -1,19 +1,38 @@
-### Xceleration Reward Station
-
-Client library for Xceleration rewardstation.com service
+# Xceleration Reward Station
 
+Client library for Xceleration rewardstation.com SOAP service
 
 ## Basic Usage
 
-#Initialization
-    reward_station = RewardStation::Service.new :client_id => "112112", :client_password => "fsdftr#"
+Common scenario is creating client instance using required parameters `:client_id` and `:client_password`.
+Client implements several methods for accessing reward station SOAP API.
+
+### Initialization
+
+    reward_station = RewardStation::Client.new {
+        :client_id => "112112",                      # required
+        :client_password => "fsdftr#",               # required
+        :organization_id => '150',                   # optional, default Organization ID
+        :program_id => 25,                           # optional, default Program ID
+        :point_reasond_code_id => 129                # optional, default Point Reason Code ID
+        :token => "sdfweqwrtwerfasdfas"              # optional, initial Access Token value
+        :new_token_callback => lambda{ |token| ... } # optional, callback on Access Token change
+    }
+
+### New Token Callback
+You can specify callback in constructor as `lambda` or `proc`
+Or you can specify callback as block:
 
-# Return Token
-Request access token
+    reward_station.new_token_calback do |new_token|
+        # notify other client instance about new token
+    end
+
+### Return Token
+Access token request. Usually not needed on businnes level because client requests it when it became invalid or expired
 
     token = reward_station.return_token
 
-# Award Points
+### Award Points
 Update award points
 
     user_id = "130"
@@ -24,7 +43,7 @@ Update award points
 
     confirmation_number = reward_station.award_points user_id, points, description, program_id, point_reason_code_id
 
-# Create User
+### Create User
 
     user_attributes = reward_station.create_user :organization_id => '150',
                                                  :email => 'john5@company.com',
@@ -60,12 +79,95 @@ Update award points
     #    :error_message => nil
     # }
 
+### Update User
+
+Similar to 'Create User'
+
+    user_attributes = reward_station.update_user user_id, :organization_id => '150',
+                                                          :email => 'john5@company.com',
+                                                          :first_name => 'John',
+                                                          :last_name => 'Smith',
+                                                          :user_name => 'john5@company.com',
+                                                          :balance => 0
+
+
+### Return Points Summary
+
+Returns user points. Required parameter - User ID
+
+    user_id = 130
+
+    summary = service.return_point_summary user_id
+
+    puts summary.inspect
+
+    # {
+    #   :user_id => '577',
+    #   :is_active => true,
+    #   :points_earned => '465',
+    #   :points_redeemed => '0',
+    #   :points_credited => '0',
+    #   :points_balance => '465'
+    # }
+
+
+### Return Popular Products
+
+Returns an array of popular products for user
+
+    user_id = 130
+
+    popular_products = service.return_popular_products user_id
+
+    puts popular_products.inspect
+
+    # [
+    #   {
+    #    :product_id => 'MC770LLA',
+    #    :name => 'iPad 2 with Wifi - 32GB',
+    #    :description => 'The NEW Apple iPad 2 - Thinner, lighter, and full of great ideas.  Once you pick up iPad 2, it’ll be hard to put down.  That’s the idea behind the all-new design. It’s 33 percent thinner and up to 15 percent lighter, so it feels even more comfortable in your hands.  And, it makes surfing the web, checking email, watching movies, and reading books so natural, you might forget there’s incredible technology under your fingers.<br><br><b>Dual-core A5 chip</b>.<br> Two powerful cores in one A5 chip mean iPad can do twice the work at once.  You’ll notice the difference when you’re surfing the web, watching movies, making FaceTime video calls, gaming, and going from app to app to app.  Multitasking is smoother, apps load faster, and everything just works better.<br><br><b>Superfast graphics</b>. <br>With up to nine times the graphics performance, gameplay on iPad is even smoother and more realistic.  And faster graphics help apps perform better — especially those with video.  You’ll see it when you’re scrolling through your photo library, editing video with iMovie, and viewing animations in Keynote.<br><br><b>Battery life keeps on going. So you can, too.</b><br> Even with the new thinner and lighter design, iPad has the same amazing 10-hour battery life.  That’s enough juice for one flight across the ocean, or one movie-watching all-nighter, or a week’s commute across town.  The power-efficient A5 chip and iOS keep battery life from fading away, so you can get carried away.<br><br><b>Two cameras.</b><br> You’ll see two cameras on iPad — one on the front and one on the back.  They may be tiny, but they’re a big deal.  They’re designed for FaceTime video calling, and they work together so you can talk to your favorite people and see them smile and laugh back at you. The front camera puts you and your friend face-to-face.  Switch to the back camera during your video call to share where you are, who you’re with, or what’s going on around you. When you’re not using FaceTime, let the back camera roll if you see something movie-worthy. It’s HD, so whatever you shoot is a mini-masterpiece. And you can take wacky snapshots in Photo Booth. It’s the most fun a face can have.<br><br><b>Due to the demand for this item, please allow up to 8-10 weeks for delivery</b>.',
+    #    :points => '10927',
+    #    :category => 'Office & Computer',
+    #    :manufacturer => 'Apple',
+    #    :small_image_url => 'https://www.rewardstation.com/catalogimages/MC769LLA.gif',
+    #    :large_image_url => 'https://www.rewardstation.com/catalogimages/MC769LLA.jpg'
+    #   }, {
+    #   ...
+    #   }
+    # ]
+
+
+## Client Stub
+
+Client supports stub mode.
+Client stub supports all request methods supported by `RewardStation::Client` but it doesn't make requests to Reward Station API. It just returns predefined SOAP responses.
+You can override those responses in `config/reward_station/responses` folder. For example if `award_points` method response should be overridden then add `award_points.xml` file to `config/reward_station/responses` folder.
+
+### Stub Initialization
+
+    stub = RewardStation::Client.stub
+
+### config/reward_station/responses/award_points.xml
+
+    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+       <soap:Body>
+          <AwardPointsResponse xmlns="http://rswebservices.rewardstation.com/">
+             <AwardPointsResult>
+                <UserID>577</UserID>
+                <Points>10</Points>
+                <ConfirmationNumber>9376</ConfirmationNumber>
+                <ErrorMessage/>
+             </AwardPointsResult>
+          </AwardPointsResponse>
+       </soap:Body>
+    </soap:Envelope>
+
 
 ## Single-Sign-On
 
 Basic SSO logic implemented in SAML::AuthResponse class. Example usage of AuthResponse:
 
-#SessionController
+### SessionController
 
     require 'saml/auth_response'
 
@@ -110,7 +212,7 @@ Basic SSO logic implemented in SAML::AuthResponse class. Example usage of AuthRe
       end
     end
 
-# signon.html.erb
+### signon.html.erb
 
     <html>
       <body>

data/lib/reward_station/{service.rb → client.rb}

@@ -1,5 +1,5 @@
 module RewardStation
-  class Service
+  class Client
 
     def initialize options = {}
       [:client_id, :client_password].each do |arg|
@@ -19,11 +19,6 @@ module RewardStation
         @new_token_callback = options[:new_token_callback]
       end
 
-      @mode = :default
-      if options[:mode]
-        raise ArgumentError, "supported modes :default and :mock" unless [:mock, :default].include?(options[:mode].to_sym)
-        @mode = options[:mode].to_sym
-      end
     end
 
     def new_token_callback &block
@@ -31,7 +26,12 @@ module RewardStation
     end
 
     class << self
-      def client
+
+      def stub options = {}
+        RewardStation::StubClient.new options
+      end
+
+      def get_client
         @@client ||= Savon::Client.new do |wsdl|
           wsdl.document = File.join(File.dirname(__FILE__), '..', 'wsdl', 'reward_services.xml')
         end
@@ -43,7 +43,7 @@ module RewardStation
     end
 
     def logger
-      Service.logger
+      Client.logger
     end
 
     def return_token
@@ -115,10 +115,6 @@ module RewardStation
 
     protected
 
-    def mock?
-      @mode == :mock
-    end
-
     def update_token
       @token = return_token
       @new_token_callback.call(@token) if @new_token_callback
@@ -139,12 +135,7 @@ module RewardStation
     end
 
     def request method_name, params
-
-      if mock?
-        #TODO
-      end
-
-      response = Service.client.request(:wsdl, method_name , params).to_hash
+      response = get_response method_name, params
 
       logger.debug response.inspect
 
@@ -163,5 +154,9 @@ module RewardStation
       logger.error ex.backtrace.inspect
       raise ConnectionError.new
     end
+
+    def get_response method_name, params
+      Client.get_client.request(:wsdl, method_name , params).to_hash
+    end
   end
 end

data/lib/reward_station/stub_client.rb

@@ -0,0 +1,22 @@
+module RewardStation
+  class StubClient < Client
+
+    def initialize responses = {}
+      @responses = {}
+    end
+
+    protected
+
+    def get_response method_name, params
+      response = StubResponse[method_name, method_name]
+
+      raise ArgumentError, "Missing stub file for '#{method_name}' request" unless response
+
+      hash = Nori.parse(response)
+
+      raise ArgumentError, "Stub file for '#{method_name}' has incorrect format" unless hash.key?(:envelope) || hash[:envelope].key?(:body)
+
+      hash[:envelope][:body]
+    end
+  end
+end

data/lib/reward_station/stub_response.rb

@@ -0,0 +1,45 @@
+module RewardStation
+  class StubResponse
+    class << self
+
+      def gem_responses_path
+        File.join(File.dirname(__FILE__), "responses")
+      end
+
+      def local_responses_path
+        File.expand_path('config/reward_station/responses') rescue nil
+      end
+
+      def load(*args)
+        file_name = args.last
+        responses[file_name] ||= load_response_file file_name
+      end
+
+      alias_method :[], :load
+
+      private
+
+      def responses
+        @responses ||= {}
+      end
+
+      def load_response_file file_name
+        file_path = nil
+
+        if local_responses_path
+          local_path = File.join(local_responses_path, "#{file_name}.xml")
+          file_path = local_path if File.exist?(local_path)
+        end
+
+        unless file_path
+          gem_path = File.join(gem_responses_path, "#{file_name}.xml")
+          file_path = gem_path if File.exist?(gem_path)
+        end
+
+        raise ArgumentError, "Unable to load: #{file_name}" unless file_path
+
+        File.read file_path
+      end
+    end
+  end
+end

data/lib/reward_station/version.rb

@@ -1,3 +1,3 @@
 module RewardStation
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/reward_station.rb

@@ -1,10 +1,9 @@
 require 'savon'
+require 'ruby-saml'
 
-require "savon/mock"
-require 'savon/macros'
-require 'savon/mock_response'
-
+require 'reward_station/stub_response'
 require 'reward_station/errors'
-require 'reward_station/service'
+require 'reward_station/client'
+require 'reward_station/stub_client'
 
 

data/lib/saml/auth_response.rb

@@ -1,3 +1,5 @@
+require 'ruby-saml'
+
 module SAML
   class AuthResponse
 

data/reward_station.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
+
 require "reward_station/version"
 
 Gem::Specification.new do |s|
@@ -8,7 +9,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Stepan Filatov", 'Cloud Castle Inc.']
   s.email       = ["filatov.st@gmail.com"]
-  s.homepage    = "https://github.com/sfilatov/reward_station"
+  s.homepage    = "https://github.com/cloudcastle/reward_station"
   s.summary     = %q{Reward Station is a client library for rewardstation.com}
   s.description = %q{}
 
@@ -20,4 +21,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'savon', ">= 0.9.6"
+  s.add_dependency "ruby-saml-bekk", '>= 0.3.3'
 end

data/spec/reward_station/service_spec.rb

@@ -1,30 +1,44 @@
 require 'spec_helper'
 
-describe RewardStation::Service do
+describe RewardStation::Client do
 
-  let(:service) { RewardStation::Service.new :client_id => '100080', :client_password => 'fM6Rv4moz#', :token => "e285e1ed-2356-4676-a554-99d79e6284b0" }
+  let(:service) { RewardStation::Client.new :client_id => '100080', :client_password => 'fM6Rv4moz#', :token => "e285e1ed-2356-4676-a554-99d79e6284b0" }
 
   describe "required options" do
     it "should raise ArgumentError on missing client_id" do
-      lambda{ RewardStation::Service.new :client_password => "" }.should raise_error(ArgumentError)
+      lambda{ RewardStation::Client.new :client_password => "" }.should raise_error(ArgumentError)
     end
 
     it "should raise ArgumentError on missing client_password" do
-      lambda{ RewardStation::Service.new :client_id => "" }.should raise_error(ArgumentError)
+      lambda{ RewardStation::Client.new :client_id => "" }.should raise_error(ArgumentError)
     end
 
     it "should not rause ArgumentError if all required parameters present" do
-      lambda{ RewardStation::Service.new :client_id => "", :client_password => "" }.should_not raise_error(ArgumentError)
+      lambda{ RewardStation::Client.new :client_id => "", :client_password => "" }.should_not raise_error(ArgumentError)
     end
   end
 
   describe "new_token_callback" do
     it "should raise ArgumentError if options is not lambda or proc" do
-      lambda{ RewardStation::Service.new :client_id => "", :client_password => "", :new_token_callback => "" }.should raise_error(ArgumentError)
+      lambda{ RewardStation::Client.new :client_id => "", :client_password => "", :new_token_callback => "" }.should raise_error(ArgumentError)
     end
 
     it "should not raise ArgumentError if option is lambda or proc" do
-      lambda{ RewardStation::Service.new :client_id => "", :client_password => "", :new_token_callback => Proc.new { } }.should_not raise_error(ArgumentError)
+      lambda{ RewardStation::Client.new :client_id => "", :client_password => "", :new_token_callback => Proc.new { } }.should_not raise_error(ArgumentError)
+    end
+  end
+
+  describe 'stub' do
+    it "should create stub" do
+      RewardStation::Client.stub.should be_a(RewardStation::StubClient)
+    end
+
+    describe 'stub service' do
+      let(:service) {RewardStation::Client.stub}
+
+      it "should return token" do
+        service.return_token.should eq("e285e1ed-2356-4676-a554-99d79e6284b0")
+      end
     end
   end
 
@@ -69,11 +83,11 @@ describe RewardStation::Service do
 
   describe "award_points" do
     let(:service) {
-      RewardStation::Service.new :client_id => '100080',
-                                 :client_password => 'fM6Rv4moz#',
-                                 :program_id => 90,
-                                 :point_reason_code_id => 129,
-                                 :token => "e285e1ed-2356-4676-a554-99d79e6284b0"
+      RewardStation::Client.new :client_id => '100080',
+                                :client_password => 'fM6Rv4moz#',
+                                :program_id => 90,
+                                :point_reason_code_id => 129,
+                                :token => "e285e1ed-2356-4676-a554-99d79e6284b0"
     }
 
     describe "on valid response" do
@@ -223,7 +237,7 @@ describe RewardStation::Service do
   end
 
   describe "update_user" do
-    let(:service) { RewardStation::Service.new :client_id => '100080', :client_password => 'fM6Rv4moz#', :organization_id => '150', :token => "e285e1ed-2356-4676-a554-99d79e6284b0" }
+    let(:service) { RewardStation::Client.new :client_id => '100080', :client_password => 'fM6Rv4moz#', :organization_id => '150', :token => "e285e1ed-2356-4676-a554-99d79e6284b0" }
 
     describe "on create user valid request" do
       before { savon.stub(:update_user).and_return(:create_user) }

data/{lib/savon/mock.rb → spec/savon_helper.rb}

@@ -1,4 +1,15 @@
 module Savon
+  # = Savon::Spec::Macros
+  #
+  # Include this module into your RSpec tests to mock/stub Savon SOAP requests.
+  module Macros
+    def savon
+      Savon::SOAP::Response.any_instance.stub(:soap_fault?).and_return(false)
+      Savon::SOAP::Response.any_instance.stub(:http_error?).and_return(false)
+      Savon::Mock.new
+    end
+  end
+
   # = Savon::Spec::Mock
   #
   # Mocks/stubs SOAP requests executed by Savon.
@@ -30,7 +41,7 @@ module Savon
       http = { :code => 200, :headers => {}, :body => "" }
 
       case response
-        when Symbol   then http[:body] = MockResponse[soap_action, response]
+        when Symbol   then http[:body] = RewardStation::StubResponse[soap_action, response]
         when Hash     then http.merge! response
         when String   then http[:body] = response
       end
@@ -67,4 +78,5 @@ module Savon
       @soap_action = soap_action.kind_of?(Symbol) ? soap_action.to_s.lower_camelcase : soap_action
     end
   end
-end
+
+end

data/spec/spec_helper.rb

@@ -3,6 +3,8 @@ Bundler.setup
 
 require 'reward_station'
 
+require 'savon_helper'
+
 RSpec.configure do |config|
   config.mock_with :rspec
   config.include Savon::Macros

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: reward_station
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Stepan Filatov
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-18 00:00:00 +04:00
+date: 2011-07-19 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,6 +35,22 @@ dependencies:
         version: 0.9.6
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-saml-bekk
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 3
+        - 3
+        version: 0.3.3
+  type: :runtime
+  version_requirements: *id002
 description: ""
 email: 
 - filatov.st@gmail.com
@@ -52,33 +68,33 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- lib/responses/award_points/award_points.xml
-- lib/responses/award_points/award_points_invalid_token.xml
-- lib/responses/return_point_summary/return_point_summary.xml
-- lib/responses/return_point_summary/return_point_summary_invalid_token.xml
-- lib/responses/return_popular_products/return_popular_products.xml
-- lib/responses/return_popular_products/return_popular_products_invalid_token.xml
-- lib/responses/return_token/return_token.xml
-- lib/responses/return_token/return_token_invalid.xml
-- lib/responses/return_user/return_user.xml
-- lib/responses/return_user/return_user_invalid_token.xml
-- lib/responses/return_user/return_user_invalid_user.xml
-- lib/responses/update_user/create_user.xml
-- lib/responses/update_user/create_user_exists.xml
 - lib/reward_station.rb
+- lib/reward_station/client.rb
 - lib/reward_station/errors.rb
-- lib/reward_station/service.rb
+- lib/reward_station/responses/award_points.xml
+- lib/reward_station/responses/award_points_invalid_token.xml
+- lib/reward_station/responses/create_user.xml
+- lib/reward_station/responses/create_user_exists.xml
+- lib/reward_station/responses/return_point_summary.xml
+- lib/reward_station/responses/return_point_summary_invalid_token.xml
+- lib/reward_station/responses/return_popular_products.xml
+- lib/reward_station/responses/return_popular_products_invalid_token.xml
+- lib/reward_station/responses/return_token.xml
+- lib/reward_station/responses/return_token_invalid.xml
+- lib/reward_station/responses/return_user.xml
+- lib/reward_station/responses/return_user_invalid_token.xml
+- lib/reward_station/responses/return_user_invalid_user.xml
+- lib/reward_station/stub_client.rb
+- lib/reward_station/stub_response.rb
 - lib/reward_station/version.rb
 - lib/saml/auth_response.rb
-- lib/savon/macros.rb
-- lib/savon/mock.rb
-- lib/savon/mock_response.rb
 - lib/wsdl/reward_services.xml
 - reward_station.gemspec
 - spec/reward_station/service_spec.rb
+- spec/savon_helper.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: https://github.com/sfilatov/reward_station
+homepage: https://github.com/cloudcastle/reward_station
 licenses: []
 
 post_install_message: 

data/lib/savon/macros.rb

@@ -1,12 +0,0 @@
-module Savon
-  # = Savon::Spec::Macros
-  #
-  # Include this module into your RSpec tests to mock/stub Savon SOAP requests.
-  module Macros
-    def savon
-      Savon::SOAP::Response.any_instance.stub(:soap_fault?).and_return(false)
-      Savon::SOAP::Response.any_instance.stub(:http_error?).and_return(false)
-      Savon::Mock.new
-    end
-  end
-end

data/lib/savon/mock_response.rb

@@ -1,45 +0,0 @@
-module Savon
-  class MockResponse
-    class << self
-
-      def gem_responses_path
-        File.join(File.dirname(__FILE__), "..", "responses")
-      end
-
-      def local_responses_path
-        File.expand_path('config/responses') rescue nil
-      end
-
-      def load(*args)
-        file = args.map { |arg| arg.to_s.snakecase }.join("/")
-        responses[file] ||= load_response_file file
-      end
-
-      alias_method :[], :load
-
-      private
-
-      def responses
-        @responses ||= {}
-      end
-
-      def load_response_file(file)
-        file_path = nil
-
-        if local_responses_path
-          local_path = File.join(local_responses_path, "#{file}.xml")
-          file_path = local_path if File.exist?(local_path)
-        end
-
-        unless file_path
-          gem_path = File.join(gem_responses_path, "#{file}.xml")
-          file_path = gem_path if File.exist?(gem_path)
-        end
-
-        raise ArgumentError, "Unable to load: #{file}" unless file_path
-
-        File.read file_path
-      end
-    end
-  end
-end