perka 1.0.pre

data/spec/api_integrator_spec.rb

@@ -0,0 +1,210 @@
+require 'perka'
+
+#INTEGRATOR_ID = 'e475e342-a542-11e1-9f8d-cde92706a93d'
+#INTEGRATOR_SECRET = 'integrator'
+#API_BASE = 'http://localhost'
+
+INTEGRATOR_ID = '44ff7a20-cb63-11e1-9b23-0800200c9a66'
+INTEGRATOR_SECRET = 'foobar'
+API_BASE = 'https://sandbox.getperka.com'
+
+describe Perka::PerkaApi do
+  context "as an integrator user" do
+  
+    # sets up an api instance for all of our tests to use
+    before(:all) do
+      @api = Perka::PerkaApi.new({
+        :flatpack => Flatpack::Core::Flatpack.new({
+          :pretty => true, 
+          :verbose => true,
+          :entity_module => Perka::Model
+        }),
+        :server_base => API_BASE,
+        :verbose => true 
+      })
+      @api.oauth_integrator_login(INTEGRATOR_ID, INTEGRATOR_SECRET)
+    end
+  
+    # clear out all customer data before each test
+    before(:each) do
+      @api.integrator_destroy_delete.execute
+    end
+    
+    it "creates a new managed customer" do
+      @api.oauth_integrator_login(INTEGRATOR_ID, INTEGRATOR_SECRET)
+      
+      cred = Perka::Model::UserCredentials.new({
+        :email => 'joe@getperka.com',
+        :phone => '+15555555555'
+      })
+      customer = @api.integrator_customer_post(cred).execute
+      
+      customer.unconfirmed_email.should eq('joe@getperka.com')
+      customer.unconfirmed_phone.should eq('+15555555555')
+    
+      # another request with the same credentials should yield the same customer
+      new_customer = @api.integrator_customer_post(cred).execute
+      new_customer.uuid.should eq(customer.uuid)
+    
+      # another request with the same email and different phone should 
+      # also yield the same customer
+      cred = Perka::Model::UserCredentials.new({
+        :email => 'joe@getperka.com',
+        :phone => '+17777777777'
+      })
+      new_customer = @api.integrator_customer_post(cred).execute
+      new_customer.uuid.should eq(customer.uuid)
+    
+      # similarly, same phone and different email
+      cred = Perka::Model::UserCredentials.new({
+        :email => 'joe+another@getperka.com',
+        :phone => '+15555555555'
+      })
+      new_customer = @api.integrator_customer_post(cred).execute
+      new_customer.uuid.should eq(customer.uuid)
+      
+      # another request with unique values should yield a new customer
+      cred = Perka::Model::UserCredentials.new({
+        :email => 'joe+yet_another@getperka.com'
+      })
+      new_customer = @api.integrator_customer_post(cred).execute
+      new_customer.uuid.should_not eq(customer.uuid)
+    end
+    
+    it "rewards punches to a new customer" do
+      @api.oauth_integrator_login(INTEGRATOR_ID, INTEGRATOR_SECRET)
+      
+      # we'll first create a new customer
+      cred = Perka::Model::UserCredentials.new(:email => 'joe+yet_another@getperka.com')
+      customer = @api.integrator_customer_post(cred).execute
+      
+      # determine the merchants associated with this integrator account.
+      merchants = @api.integrator_managed_merchants_get.execute
+      
+      # lets assume this integrator has only one managed merchant
+      merchant = merchants.first
+      
+      # By default, API endpoints DO NOT return a full object graph of data.  
+      # For example, the above integrator_managed_merchants_get endpoint returns
+      # only the merchant with no associated location or program data.  The 
+      # describe_type_uuid_get endpoint is an exception to this rule, and will 
+      # always peform a deep serialization of the entity being described.  We'll 
+      # now describe our merchant to gain access to our location and program data.
+      merchant = @api.describe_entity_get(merchant).execute
+      
+      # The merchant's locations should now be populated
+      location = merchant.merchant_locations.first
+      
+      # The program data should also be populated, so we can dig down and grab
+      # a program type that we'd like to award points for
+      program_type = merchant.program_tiers.first.programs.first.program_type
+      
+      # now we'll switch our session over to a clerk at the merchant location.
+      # This will authorize our API to execute clerk enabled endpoints.
+      @api = @api.oauth_integrator_become("CLERK", location.uuid)
+      
+      # we can now assign some loyalty punches to our new customer
+      visit = @api.customer_reward_put(Perka::Model::RewardGrant.new({
+        :customer => customer,
+        :reward_confirmations => [
+          Perka::Model::PunchRewardConfirmation.new({
+            :program_type => program_type,
+            :punches_earned => 2
+          })
+        ]
+      })).execute
+      
+      # A new visit should have been returned describing the transaction.
+      # The customer and merchant location should be what we specified
+      visit.customer.uuid.should eq(customer.uuid)
+      visit.merchant_location.uuid.should eq(location.uuid)
+      
+      # A new reward should have been advanced by 2 punches
+      visit.reward_advancements.length.should eq(1)
+      advancement = visit.reward_advancements.first
+      advancement.punches_earned.should eq(2)
+      
+      # The reward should show a sum of only 2 punches since this is a new customer
+      advancement.reward.punches_earned.should eq(2)
+      
+      # We'll now pull down the customer's reward status
+      rewards = @api.customer_reward_get.with_customer_uuid(customer.uuid).execute
+      
+      # We should have only one non-activated, non-redeemed reward with 2 punches
+      rewards.length.should eq(1)
+      rewards.first.activated_at.should be_nil
+      rewards.first.redeemed_at.should be_nil
+      rewards.first.punches_earned.should eq(2)
+      
+      # Now we'll give the customer another 9 punches, which should activate the 
+      # reward and make it available for redemption, and will create another 
+      # reward with a single punch
+      @api.customer_reward_put(Perka::Model::RewardGrant.new({
+        :customer => customer,
+        :reward_confirmations => [
+          Perka::Model::PunchRewardConfirmation.new({
+            :program_type => program_type,
+            :punches_earned => 9
+          })
+        ]
+      })).execute
+      
+      # The customer should now one activated, and one non-activated reward
+      rewards = @api.customer_reward_get.with_customer_uuid(customer.uuid).execute
+      rewards.length.should eq(2)
+      active_reward = rewards.detect {|r| r.activated_at }
+      active_reward.activated_at.should_not be_nil
+      active_reward.redeemed_at.should be_nil
+      active_reward.punches_earned.should eq(10)
+      
+      inactive_reward = rewards.detect {|r| !r.activated_at }
+      inactive_reward.activated_at.should be_nil
+      inactive_reward.redeemed_at.should be_nil
+      inactive_reward.punches_earned.should eq(1)
+      
+      # We'll now redeem the active reward.  We can also award 
+      # more punches in the same transaction
+      @api.customer_reward_put(Perka::Model::RewardGrant.new({
+        :customer => customer,
+        :reward_confirmations => [
+          Perka::Model::RedemptionRewardConfirmation.new({
+            :reward => active_reward
+          }),
+          Perka::Model::PunchRewardConfirmation.new({
+            :program_type => program_type,
+            :punches_earned => 1
+          })
+        ]
+      })).execute
+      
+      # The customer status should now show just one non-active 
+      # reward with 2 punches
+      rewards = @api.customer_reward_get.with_customer_uuid(customer.uuid).execute
+      rewards.length.should eq(1)
+      rewards.first.activated_at.should be_nil
+      rewards.first.redeemed_at.should be_nil
+      rewards.first.punches_earned.should eq(2)
+    end
+    
+    it "annotate entities with arbitrary JSON data" do
+      @api.oauth_integrator_login(INTEGRATOR_ID, INTEGRATOR_SECRET)
+      
+      # first we'll grab a reference to one of our managed merchants
+      merchants = @api.integrator_managed_merchants_get.execute
+      merchant = merchants.first
+      
+      # then apply an arbitrary annotation to the merchant
+      json = "{'foo':'bar'}"
+      @api.annotation_put(Perka::Model::EntityAnnotation.new({
+        :annotation => json,
+        :entity => merchant
+      })).execute
+      
+      # which can be retreived at any time
+      annotation = @api.annotation_entity_get(merchant).execute
+      annotation.annotation.should eq(json)
+    end
+    
+  end
+  
+end

data/spec/model_spec.rb

@@ -0,0 +1,24 @@
+require 'perka'
+
+describe Perka::Model do
+  it "should pass a smoke test" do
+    c = Perka::Model::Customer.new({
+      :avatar_url => 'avatar',
+      :first_name => 'Joe',
+      :junk => 'junk'
+    })
+    c.last_name = 'Stelmach'
+
+    c.avatar_url.should eq('avatar')
+    c.first_name.should eq('Joe')
+    c.last_name.should eq('Stelmach')
+    
+    flatpack = Flatpack::Core::Flatpack.new({
+      :pretty => false, 
+      :verbose => false,
+      :entity_module => Perka::Model
+    })
+    flatpack.packer.pack(c)
+  end
+  
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification 
+name: perka
+version: !ruby/object:Gem::Version 
+  hash: 174811731
+  prerelease: true
+  segments: 
+  - 1
+  - 0
+  - pre
+  version: 1.0.pre
+platform: ruby
+authors: 
+- Joe Stelmach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-27 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: flatpack_client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 174811731
+        segments: 
+        - 1
+        - 0
+        - pre
+        version: 1.0.pre
+  type: :runtime
+  version_requirements: *id002
+description: Write a gem description
+email: 
+- joe@getperka.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/perka.rb
+- lib/perka/client_api.rb
+- lib/perka/model/abstract_reward_confirmation.rb
+- lib/perka/model/abstract_user.rb
+- lib/perka/model/api_description.rb
+- lib/perka/model/base_entity_global.rb
+- lib/perka/model/bounce_back_target.rb
+- lib/perka/model/canned_email_outbound_message.rb
+- lib/perka/model/clerk.rb
+- lib/perka/model/composite_target.rb
+- lib/perka/model/console_message.rb
+- lib/perka/model/coupon.rb
+- lib/perka/model/coupon_campaign.rb
+- lib/perka/model/coupon_redemption.rb
+- lib/perka/model/coupon_target.rb
+- lib/perka/model/coupon_visibility.rb
+- lib/perka/model/customer.rb
+- lib/perka/model/customer_device.rb
+- lib/perka/model/endpoint_description.rb
+- lib/perka/model/entity_annotation.rb
+- lib/perka/model/entity_description.rb
+- lib/perka/model/everybody_target.rb
+- lib/perka/model/feedback_item.rb
+- lib/perka/model/first_visit_target.rb
+- lib/perka/model/idle_customer_target.rb
+- lib/perka/model/integrator_user.rb
+- lib/perka/model/internal_user.rb
+- lib/perka/model/like_to_unlock_target.rb
+- lib/perka/model/list_target.rb
+- lib/perka/model/merchant.rb
+- lib/perka/model/merchant_capability.rb
+- lib/perka/model/merchant_device.rb
+- lib/perka/model/merchant_location.rb
+- lib/perka/model/merchant_user.rb
+- lib/perka/model/nobody_target.rb
+- lib/perka/model/outbound_message.rb
+- lib/perka/model/parameter_description.rb
+- lib/perka/model/participation_target.rb
+- lib/perka/model/physical_redemption_target.rb
+- lib/perka/model/points_activity.rb
+- lib/perka/model/points_activity_confirmation.rb
+- lib/perka/model/points_catalog_item.rb
+- lib/perka/model/program.rb
+- lib/perka/model/program_tier.rb
+- lib/perka/model/program_type.rb
+- lib/perka/model/property.rb
+- lib/perka/model/punch_reward_confirmation.rb
+- lib/perka/model/push_message.rb
+- lib/perka/model/redemption_coupon_confirmation.rb
+- lib/perka/model/redemption_reward_confirmation.rb
+- lib/perka/model/reward.rb
+- lib/perka/model/reward_advancement.rb
+- lib/perka/model/reward_grant.rb
+- lib/perka/model/sms_message.rb
+- lib/perka/model/sms_outbound_message.rb
+- lib/perka/model/social_list_target.rb
+- lib/perka/model/social_service_subscription.rb
+- lib/perka/model/street_address.rb
+- lib/perka/model/tier_target.rb
+- lib/perka/model/tier_traversal.rb
+- lib/perka/model/tier_traversal_confirmation.rb
+- lib/perka/model/type.rb
+- lib/perka/model/user_credentials.rb
+- lib/perka/model/visit.rb
+- lib/perka/model/visit_confirmation.rb
+- lib/perka/model/weather_target.rb
+- lib/perka/model/yield_management_target.rb
+- lib/perka/perka_api.rb
+- lib/perka/version.rb
+- lib/perka_fast.rb
+- perka.gemspec
+- spec/api_integrator_spec.rb
+- spec/model_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Write a gem summary
+test_files: 
+- spec/api_integrator_spec.rb
+- spec/model_spec.rb