reward_station 0.0.1 → 0.0.2

data/lib/savon/macros.rb

@@ -0,0 +1,12 @@
+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.rb

@@ -0,0 +1,70 @@
+module Savon
+  # = Savon::Spec::Mock
+  #
+  # Mocks/stubs SOAP requests executed by Savon.
+  class Mock
+
+    def expects(soap_action)
+      setup :expects, soap_action
+      self
+    end
+
+    def stub(soap_action)
+      setup :stub, soap_action
+      self
+    end
+
+    # Expects a given SOAP body Hash to be used.
+    def with(soap_body)
+      Savon::SOAP::XML.any_instance.expects(:body=).with(soap_body) if mock_method == :expects
+      self
+    end
+
+    def never
+      httpi_mock.never
+      self
+    end
+
+    # Sets up HTTPI to return a given +response+.
+    def and_return(response = nil)
+      http = { :code => 200, :headers => {}, :body => "" }
+
+      case response
+        when Symbol   then http[:body] = MockResponse[soap_action, response]
+        when Hash     then http.merge! response
+        when String   then http[:body] = response
+      end
+
+      httpi_mock.and_return HTTPI::Response.new(http[:code], http[:headers], http[:body])
+      self
+    end
+
+    # Sets up Savon to respond like there was a SOAP fault.
+    def raises_soap_fault
+      Savon::SOAP::Response.any_instance.stub(:soap_fault?).and_return(true)
+      self
+    end
+
+    def raises_http_error
+      Savon::SOAP::Response.any_instance.stub(:soap_fault?).and_return(false)
+      Savon::SOAP::Response.any_instance.stub(:http_error?).and_return(true)
+      self
+    end
+
+    private
+
+    def setup(mock_method, soap_action)
+      self.mock_method = mock_method
+      self.soap_action = soap_action
+      self.httpi_mock = HTTPI.send(mock_method, :post)
+    end
+
+    attr_accessor :mock_method
+    attr_accessor :httpi_mock
+
+    attr_reader :soap_action
+    def soap_action=(soap_action)
+      @soap_action = soap_action.kind_of?(Symbol) ? soap_action.to_s.lower_camelcase : soap_action
+    end
+  end
+end

data/lib/savon/mock_response.rb

@@ -0,0 +1,45 @@
+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

data/reward_station.gemspec

@@ -6,11 +6,11 @@ Gem::Specification.new do |s|
   s.name        = "reward_station"
   s.version     = RewardStation::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Stepan Filatov"]
+  s.authors     = ["Stepan Filatov", 'Cloud Castle Inc.']
   s.email       = ["filatov.st@gmail.com"]
   s.homepage    = "https://github.com/sfilatov/reward_station"
-  s.summary     = %q{Reward Station is a client implementation of the Xceleration Reward Station service API}
-  s.description = %q{Reward Station is a client implementation of the Xceleration Reward Station service API}
+  s.summary     = %q{Reward Station is a client library for rewardstation.com}
+  s.description = %q{}
 
   s.rubyforge_project = "reward_station"
 
@@ -18,4 +18,6 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  s.add_dependency 'savon', ">= 0.9.6"
 end

data/spec/reward_station/service_spec.rb

@@ -0,0 +1,326 @@
+require 'spec_helper'
+
+describe RewardStation::Service do
+
+  let(:service) { RewardStation::Service.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)
+    end
+
+    it "should raise ArgumentError on missing client_password" do
+      lambda{ RewardStation::Service.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)
+    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)
+    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)
+    end
+  end
+
+  describe "return_token" do
+
+    describe "on valid response" do
+      before { savon.stub(:return_token).and_return(:return_token) }
+
+      it "should return valid token" do
+        service.return_token.should eq("e285e1ed-2356-4676-a554-99d79e6284b0")
+      end
+
+      it "should not raise InvalidAccount exception" do
+        lambda{ service.return_token }.should_not raise_error(RewardStation::InvalidAccount)
+      end
+    end
+
+    describe "on invalid account response" do
+      before { savon.stub(:return_token).and_return(:return_token_invalid) }
+
+      it "should raise InvalidAccount exception" do
+        lambda{ service.return_token }.should raise_error(RewardStation::InvalidAccount)
+      end
+    end
+
+    describe "on soap error" do
+      before { savon.stub(:return_token).and_return.raises_soap_fault }
+
+      it "should raise ConnectionError exception" do
+        lambda{ service.return_token }.should raise_error(RewardStation::ConnectionError)
+      end
+    end
+
+    describe "on http error" do
+      before { savon.stub(:return_token).and_return(:code => 404).raises_http_error }
+
+      it "should raise HttpError exception" do
+        lambda{ service.return_token }.should raise_error(RewardStation::ConnectionError)
+      end
+    end
+  end
+
+  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"
+    }
+
+    describe "on valid response" do
+      before { savon.stub(:award_points).and_return(:award_points) }
+
+      it "should return valid confirm code" do
+        service.award_points(130, 10, "Action 'Some' taken").should eq("9376")
+      end
+    end
+
+    describe "on invalid token response" do
+      before { savon.stub(:award_points).and_return(:award_points_invalid_token) }
+
+      it "should not raise InvalidToken exception" do
+        lambda{ service.award_points(130, 10, "Action 'Some' taken") }.should_not raise_error(RewardStation::InvalidToken)
+      end
+    end
+
+    describe "on soap error" do
+      before { savon.stub(:award_points).and_return.raises_soap_fault }
+
+      it "should raise ConnectionError exception" do
+        lambda{ service.award_points(130, 10, "Action 'Some' taken") }.should raise_error(RewardStation::ConnectionError)
+      end
+    end
+
+    describe "on http error" do
+      before { savon.stub(:award_points).and_return(:code => 404).raises_http_error }
+
+      it "should raise HttpError exception" do
+        lambda{ service.award_points(130, 10, "Action 'Some' taken") }.should raise_error(RewardStation::ConnectionError)
+      end
+    end
+
+  end
+
+  describe "return_user" do
+
+    describe "on valid response" do
+      before { savon.stub(:return_user).and_return(:return_user) }
+
+      it "should return valid user data" do
+        service.return_user(130).should eq(:user_id => '6725',
+                                           :client_id => '100080',
+                                           :user_name => 'john3@company.com',
+                                           :encrypted_password => nil,
+                                           :first_name => 'John',
+                                           :last_name => 'Smith',
+                                           :address_one => nil,
+                                           :address_two => nil,
+                                           :city => nil,
+                                           :state_code => nil,
+                                           :province => nil,
+                                           :postal_code => nil,
+                                           :country_code => 'USA',
+                                           :phone => nil,
+                                           :email => 'john@company.com',
+                                           :organization_id => '0',
+                                           :organization_name => nil,
+                                           :rep_type_id => '0',
+                                           :client_region_id => '0',
+                                           :is_active => true,
+                                           :point_balance => '10',
+                                           :manager_id => '0',
+                                           :error_message => nil)
+      end
+
+      it "should not raise InvalidToken exception" do
+        lambda{ service.return_user(130) }.should_not raise_error(RewardStation::InvalidToken)
+      end
+    end
+
+    describe "on invalid token response" do
+      before { savon.stub(:return_user).and_return(:return_user_invalid_token) }
+
+      it "should not raise InvalidToken exception" do
+        lambda{ service.return_user(130) }.should_not raise_error(RewardStation::InvalidToken)
+      end
+    end
+
+    describe "on invalid user response" do
+      before { savon.stub(:return_user).and_return(:return_user_invalid_user) }
+
+      it "should raise InvalidUser exception" do
+        lambda{ service.return_user(130) }.should raise_error(RewardStation::InvalidUser)
+      end
+    end
+
+    describe "on soap error" do
+      before { savon.stub(:return_user).and_return.raises_soap_fault }
+
+      it "should raise ConnectionError exception" do
+        lambda{ service.return_user(130) }.should raise_error(RewardStation::ConnectionError)
+      end
+    end
+
+    describe "on http error" do
+      before { savon.stub(:return_user).and_return(:code => 404).raises_http_error }
+
+      it "should raise HttpError exception" do
+        lambda{ service.return_user(130) }.should raise_error(RewardStation::ConnectionError)
+      end
+    end
+  end
+
+  describe "return_point_summary" do
+    describe "on valid request" do
+      before { savon.stub(:return_point_summary).and_return(:return_point_summary) }
+
+      it "should return valid summary" do
+        service.return_point_summary(130).should eq(:user_id => '577',
+                                                    :is_active => true,
+                                                    :points_earned => '465',
+                                                    :points_redeemed => '0',
+                                                    :points_credited => '0',
+                                                    :points_balance => '465')
+      end
+
+      it "should not raise InvalidToken exception" do
+        lambda{ service.return_point_summary(130) }.should_not raise_error(RewardStation::InvalidToken)
+      end
+    end
+
+    describe "on invalid token request" do
+      before { savon.stub(:return_point_summary).and_return(:return_point_summary_invalid_token) }
+
+      it "should not raise InvalidToken exception" do
+        lambda{ service.return_point_summary(130) }.should_not raise_error(RewardStation::InvalidToken)
+      end
+    end
+
+    describe "on soap error" do
+      before { savon.stub(:return_point_summary).and_return.raises_soap_fault }
+
+      it "should raise ConnectionError exception" do
+        lambda{ service.return_point_summary(130) }.should raise_error(RewardStation::ConnectionError)
+      end
+    end
+
+    describe "on http error" do
+      before { savon.stub(:return_point_summary).and_return(:code => 404).raises_http_error }
+
+      it "should raise HttpError exception" do
+        lambda{ service.return_point_summary(130) }.should raise_error(RewardStation::ConnectionError)
+      end
+    end
+  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" }
+
+    describe "on create user valid request" do
+      before { savon.stub(:update_user).and_return(:create_user) }
+
+      it "should return valid response" do
+        service.create_user(
+            :email => 'john5@company.com',
+            :first_name => 'John',
+            :last_name => 'Smith',
+            :user_name => 'john5@company.com',
+            :balance => 0
+        ).should eq(:user_id => '6727',
+                    :client_id => '100080',
+                    :user_name => 'john5@company.com',
+                    :email => 'john5@company.com',
+                    :encrypted_password => nil,
+                    :first_name => 'John',
+                    :last_name => 'Smith',
+                    :address_one => nil,
+                    :address_two => nil,
+                    :city => nil,
+                    :state_code => nil,
+                    :province => nil,
+                    :postal_code => nil,
+                    :country_code => 'USA',
+                    :phone => nil,
+                    :organization_id => '150',
+                    :organization_name => nil,
+                    :rep_type_id => '0',
+                    :client_region_id => '0',
+
+                    :is_active => true,
+                    :point_balance => '0',
+                    :manager_id => '0',
+                    :error_message => nil)
+      end
+
+      it "should not raise InvalidToken exception" do
+        lambda{
+          service.create_user(:email => 'john5@company.com',
+                              :first_name => 'John',
+                              :last_name => 'Smith',
+                              :user_name => 'john5@company.com',
+                              :balance => 0)
+        }.should_not raise_error(RewardStation::InvalidToken)
+      end
+    end
+
+    describe "on create user invalid request" do
+      before { savon.stub(:update_user).and_return(:create_user_exists) }
+
+      it "should raise UserAlreadyExists exception" do
+        lambda{
+          service.update_user(130, {
+              :email => 'john5@company.com',
+              :first_name => 'John',
+              :last_name => 'Smith',
+              :user_name => 'john5@company.com',
+              :balance => 0
+          })
+        }.should raise_error(RewardStation::UserAlreadyExists)
+      end
+    end
+
+  end
+
+  describe "return_popular_products" do
+    describe "on valid request" do
+      before { savon.stub(:return_popular_products).and_return(:return_popular_products) }
+
+      it "should return valid response" do
+        products = service.return_popular_products(130)
+        products.should be_a(Array)
+        products.size.should eq(35)
+        products.first.should eq(: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')
+      end
+
+      it "should not raise InvalidToken exception" do
+        lambda{ service.return_popular_products(130) }.should_not raise_error(RewardStation::InvalidToken)
+      end
+    end
+
+    describe "on create user invalid token request" do
+      before { savon.stub(:return_popular_products).and_return(:return_popular_products_invalid_token) }
+
+      it "should not raise InvalidToken exception" do
+        lambda{ service.return_popular_products(130) }.should_not raise_error(RewardStation::InvalidToken)
+      end
+    end
+
+  end
+
+end