perka 1.0.pre

data/lib/perka/model/reward_grant.rb

@@ -0,0 +1,37 @@
+# Generated File - DO NOT EDIT
+
+require 'flatpack_core'
+
+module Perka
+  module Model 
+
+    # Encapsulates one or more <entityReference payloadName='abstractRewardConfirmation'> 
+    # AbstractRewardConfirmation</entityReference> objects to be given to a customer. 
+    # <p> This differs from a <entityReference payloadName='visitConfirmation'> 
+    # VisitConfirmation</entityReference> in that there's no previously-created 
+    # Visit object to confirm. Instead, a RewardGrant will create a confirmed Visit 
+    # and possibly create a Customer object based on an email address or SMS phone 
+    # number. The UUID of the Visit object will be set to the RewardGrant's UUID 
+    # to allow post-grant correlation. <p> Exactly one of <entityReference payloadName='rewardGrant'> 
+    # #getCustomerEmail()</entityReference>, <entityReference payloadName='rewardGrant'> 
+    # #getCustomerPhone()</entityReference>, or <entityReference payloadName='rewardGrant'> 
+    # #getCustomerUuid()</entityReference> must be provided to identify the customer.
+    class RewardGrant < Flatpack::Core::BaseHasUuid
+
+      PROPERTY_NAMES = [
+        :customer,
+
+        # At least one <entityReference payloadName='abstractRewardConfirmation'> 
+        # AbstractRewardConfirmation</entityReference> must be given.
+        :reward_confirmations
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/customer'
+      TYPE_MAP = {
+        :customer => Perka::Model::Customer
+      }
+
+    end
+  end
+end

data/lib/perka/model/sms_message.rb

@@ -0,0 +1,15 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Records the receipt of an SMS message.
+    class SmsMessage < BaseEntityGlobal
+
+
+
+    end
+  end
+end

data/lib/perka/model/sms_outbound_message.rb

@@ -0,0 +1,14 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/outbound_message'
+
+module Perka
+  module Model 
+
+    class SmsOutboundMessage < OutboundMessage
+
+
+
+    end
+  end
+end

data/lib/perka/model/social_list_target.rb

@@ -0,0 +1,14 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/list_target'
+
+module Perka
+  module Model 
+
+    class SocialListTarget < ListTarget
+
+
+
+    end
+  end
+end

data/lib/perka/model/social_service_subscription.rb

@@ -0,0 +1,26 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Represents a customer's preference to have a specific social event posted 
+    # to a specific social backend.
+    class SocialServiceSubscription < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :customer,
+        :social_action,
+        :social_service
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/customer'
+      TYPE_MAP = {
+        :customer => Perka::Model::Customer
+      }
+
+    end
+  end
+end

data/lib/perka/model/street_address.rb

@@ -0,0 +1,27 @@
+# Generated File - DO NOT EDIT
+
+require 'flatpack_core'
+
+module Perka
+  module Model 
+
+    # A simple representation of a mailing address. It is intended to be used as 
+    # a payload carrier object or as an embeddable JPA object. <p> All of the properties 
+    # in this object are marked as PermitAll because access to the StreetAddress 
+    # itself is controlled by the enclosing object.
+    class StreetAddress < Flatpack::Core::BaseHasUuid
+
+      PROPERTY_NAMES = [
+        :address_2,
+        :city,
+        :zip,
+        :address,
+        :state,
+        :country
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+
+    end
+  end
+end

data/lib/perka/model/tier_target.rb

@@ -0,0 +1,24 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/coupon_target'
+
+module Perka
+  module Model 
+
+    # Makes coupons available to customers who are members of a given <entityReference 
+    # payloadName='programTier'> ProgramTier</entityReference>.
+    class TierTarget < CouponTarget
+
+      PROPERTY_NAMES = [
+        :program_tier
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/program_tier'
+      TYPE_MAP = {
+        :program_tier => Perka::Model::ProgramTier
+      }
+
+    end
+  end
+end

data/lib/perka/model/tier_traversal.rb

@@ -0,0 +1,30 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Maps a <entityReference payloadName='customer'> Customer</entityReference> 
+    # to a <entityReference payloadName='programTier'> ProgramTier</entityReference> 
+    # and provides the total number of validated visits to the associated <entityReference 
+    # payloadName='merchant'> Merchant</entityReference>.
+    class TierTraversal < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :customer,
+        :program_tier,
+        :visit_count
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/program_tier'
+      require 'perka/model/customer'
+      TYPE_MAP = {
+        :program_tier => Perka::Model::ProgramTier,
+        :customer => Perka::Model::Customer
+      }
+
+    end
+  end
+end

data/lib/perka/model/tier_traversal_confirmation.rb

@@ -0,0 +1,28 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/abstract_reward_confirmation'
+
+module Perka
+  module Model 
+
+    # Allows a customer to be placed in an arbitrary program tier. This confirmation 
+    # type may be used to demote a customer to a lower tier if the customer does 
+    # not meet the visit count requirement for membership in its current tier.
+    class TierTraversalConfirmation < AbstractRewardConfirmation
+
+      PROPERTY_NAMES = [
+
+        # The ProgramTier that the customer associated with the visit should be 
+        # moved into.
+        :program_tier
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/program_tier'
+      TYPE_MAP = {
+        :program_tier => Perka::Model::ProgramTier
+      }
+
+    end
+  end
+end

data/lib/perka/model/type.rb

@@ -0,0 +1,33 @@
+# Generated File - DO NOT EDIT
+
+require 'flatpack_core'
+
+module Perka
+  module Model 
+
+    # A simple JSON type description.
+    class Type < Flatpack::Core::BaseHasUuid
+
+      PROPERTY_NAMES = [
+        :json_kind,
+        :enum_values,
+        :list_element,
+        :map_key,
+        :map_value,
+        :type_hint,
+        :name
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/type'
+      require 'perka/model/type'
+      require 'perka/model/type'
+      TYPE_MAP = {
+        :map_key => Perka::Model::Type,
+        :list_element => Perka::Model::Type,
+        :map_value => Perka::Model::Type
+      }
+
+    end
+  end
+end

data/lib/perka/model/user_credentials.rb

@@ -0,0 +1,28 @@
+# Generated File - DO NOT EDIT
+
+require 'flatpack_core'
+
+module Perka
+  module Model 
+
+    # A transfer object used to hold data related to account creation and maintenance.
+    class UserCredentials < Flatpack::Core::BaseHasUuid
+
+      PROPERTY_NAMES = [
+        :email,
+        :first_name,
+        :last_name,
+        :new_password,
+        :new_password_confirmation,
+        :phone,
+        :phone_confirmation_code,
+        :current_password,
+        :hmac,
+        :user_uuid
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+
+    end
+  end
+end

data/lib/perka/model/visit.rb

@@ -0,0 +1,59 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Represents a check-in at a <entityReference payloadName='merchantLocation'> 
+    # MerchantLocation</entityReference> by a <entityReference payloadName='customer'> 
+    # Customer</entityReference>.
+    class Visit < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :customer,
+
+        # Where the Visit occurred.
+        :merchant_location,
+
+        # Indicates that the Visit was created via the SMS endpoint and not from 
+        # an app.
+        :sms,
+
+        # The latest <entityReference payloadName='pointsActivity'> PointsActivity</entityReference> 
+        # for the Visit's <entityReference payloadName='customer'> Customer</entityReference> 
+        # at the <entityReference payloadName='merchantLocation'> MerchantLocation</entityReference>. 
+        # This may be null if the customer has no previous points activity at the 
+        # merchant.
+        :current_points_activity,
+
+        # The punches earned during the Visit, broken out by <entityReference payloadName='reward'> 
+        # Reward</entityReference>.
+        :reward_advancements,
+
+        # The time at which the visit was confirmed by the clerk.
+        :validated_at,
+
+        # The <entityReference payloadName='coupon'> Coupons</entityReference> that 
+        # were redeemed during the visit.
+        :coupon_redemptions,
+
+        # Any feedback left by the Customer after the Visit was validated.
+        :feedback_item
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/feedback_item'
+      require 'perka/model/points_activity'
+      require 'perka/model/merchant_location'
+      require 'perka/model/customer'
+      TYPE_MAP = {
+        :feedback_item => Perka::Model::FeedbackItem,
+        :current_points_activity => Perka::Model::PointsActivity,
+        :merchant_location => Perka::Model::MerchantLocation,
+        :customer => Perka::Model::Customer
+      }
+
+    end
+  end
+end

data/lib/perka/model/visit_confirmation.rb

@@ -0,0 +1,47 @@
+# Generated File - DO NOT EDIT
+
+require 'flatpack_core'
+
+module Perka
+  module Model 
+
+    # Confirms a previously-created <entityReference payloadName='visit'> Visit</entityReference> 
+    # that was the result of a <entityReference payloadName='customer'> Customer</entityReference> 
+    # checking into a location.
+    class VisitConfirmation < Flatpack::Core::BaseHasUuid
+
+      PROPERTY_NAMES = [
+
+        # The <entityReference payloadName='customer'> Customer</entityReference> 
+        # associated with the <entityReference payloadName='visit'> Visit</entityReference>. 
+        # This property is usually inferred from the associated <entityReference 
+        # payloadName='visit'> Visit</entityReference>.
+        :customer,
+
+        # The <entityReference payloadName='merchant'> Merchant</entityReference> 
+        # associated with the <entityReference payloadName='visit'> Visit</entityReference>. 
+        # This property is usually inferred from the associated <entityReference 
+        # payloadName='visit'> Visit</entityReference>.
+        :merchant,
+
+        # The previously-created <entityReference payloadName='visit'> Visit</entityReference> 
+        # that is associated with a customer checkin.
+        :visit,
+
+        # The rewards associated with the visit (e.g. punches earned, coupons redeemed).
+        :reward_confirmations
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/merchant'
+      require 'perka/model/visit'
+      require 'perka/model/customer'
+      TYPE_MAP = {
+        :merchant => Perka::Model::Merchant,
+        :visit => Perka::Model::Visit,
+        :customer => Perka::Model::Customer
+      }
+
+    end
+  end
+end

data/lib/perka/model/weather_target.rb

@@ -0,0 +1,27 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/list_target'
+
+module Perka
+  module Model 
+
+    class WeatherTarget < ListTarget
+
+      PROPERTY_NAMES = [
+        :operation,
+        :metric,
+        :threshold,
+
+        # The local minutes-of-day after which the availability of the coupon will 
+        # not change for the remainder of the day.
+        :local_decision_at,
+
+        # The time of day for which the metric threshold must be met.
+        :local_metric_at
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+
+    end
+  end
+end

data/lib/perka/model/yield_management_target.rb

@@ -0,0 +1,23 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/coupon_target'
+
+module Perka
+  module Model 
+
+    class YieldManagementTarget < CouponTarget
+
+      PROPERTY_NAMES = [
+
+        # Returns the minutes-of-day that the redemption window closes.
+        :local_redemption_end_at,
+
+        # Returns the minutes-of-day that the redemption window opens.
+        :local_redemption_start_at
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+
+    end
+  end
+end

data/lib/perka/perka_api.rb

@@ -0,0 +1,89 @@
+require 'flatpack_core'
+
+module Perka
+  class PerkaApi < Perka::ClientApi
+    
+    include Flatpack::Core::MapInitialize
+    
+    attr_accessor :access_token, :access_expiration, :refresh_token, :user_uuid
+    
+    # our session is considered active if we've never received an access
+    # token, or our token expiration as after now
+    def session_active?
+      !@access_token or @access_expiration > Time.now
+    end
+      
+    def refresh_session
+      oauth_refresh_token
+    end
+      
+    # Concrete implementations that require authentication should implement 
+    # this method if authenticated requests require custom request headers
+    def auth_headers
+      @access_token ? {'Authorization' => "Bearer #{@access_token}"} : {}
+    end
+    
+    # Grants an integrator access token
+    def oauth_integrator_login(integrator_id, integrator_secret)
+      @integrator_id = integrator_id
+      @integrator_secret = integrator_secret
+      payload = 
+        "grant_type=password"\
+        "&username=#{integrator_id}"\
+        "&client_id=#{integrator_id}"\
+        "&password=#{URI::encode(integrator_secret)}"\
+        "&scope=INTEGRATOR";
+      
+      execute_token_request(self, payload);
+    end
+    
+    # returns a new PerkaApi authorized as the given role and user
+    def oauth_integrator_become(role, uuid)
+      role = role
+      payload = "grant_type=client_credentials&scope=#{URI::encode(role)}:#{uuid}"
+      new_api = PerkaApi.new({
+        :server_base => @server_base,
+        :flatpack => @flatpack,
+        :access_token => @access_token,
+        :access_expiration => @access_expiration,
+        :verbose => @verbose,
+      })
+      execute_token_request(new_api, payload)
+      new_api
+    end
+    
+    # Obtain a new access token using integrator credentials and a refresh token.
+    def oauth_refresh_token
+      payload = "grant_type=refresh_token"\
+        "&client_id=#{@integrator_id}"\
+        "&client_secret=#{URI::encode(@integrator_secret)}"\
+        "&refresh_token=#{@refresh_token}"
+      
+      execute_token_request(self, payload);
+    end
+    
+    private 
+    
+    def execute_token_request(api, payload)
+      json = TokenRequest.new(api, payload).execute
+      status = json['status_code']
+      expires = json['expires_in']
+      api.access_expiration = Time.now + expires.to_i if expires
+      api.access_token = json['access_token']
+      api.refresh_token = json['refresh_token']
+      uuid = json['uuid']
+      api.user_uuid = uuid if uuid
+    end
+    
+    class TokenRequest < Flatpack::Client::JsonRequest
+      attr_accessor :payload
+      
+      def initialize(api, payload)
+        @payload = payload
+        super(api, "POST", "/api/2/auth/token");
+        header("Content-Type", "application/x-www-form-urlencoded");
+      end
+    end
+    
+  end
+end

data/lib/perka/version.rb

@@ -0,0 +1,3 @@
+module Perka 
+  VERSION = "1.0.pre"
+end

data/lib/perka.rb

@@ -0,0 +1,6 @@
+require "perka_fast"
+require "perka/perka_api"
+
+module Perka 
+  # Your code goes here...
+end

data/lib/perka_fast.rb

@@ -0,0 +1,68 @@
+# Generated File - DO NOT EDIT
+
+require "perka/client_api"
+require "perka/model/points_activity"
+require "perka/model/base_entity_global"
+require "perka/model/property"
+require "perka/model/api_description"
+require "perka/model/entity_annotation"
+require "perka/model/user_credentials"
+require "perka/model/customer"
+require "perka/model/merchant"
+require "perka/model/abstract_user"
+require "perka/model/clerk"
+require "perka/model/integrator_user"
+require "perka/model/internal_user"
+require "perka/model/merchant_user"
+require "perka/model/merchant_location"
+require "perka/model/reward"
+require "perka/model/reward_grant"
+require "perka/model/visit"
+require "perka/model/visit_confirmation"
+require "perka/model/points_catalog_item"
+require "perka/model/type"
+require "perka/model/endpoint_description"
+require "perka/model/entity_description"
+require "perka/model/customer_device"
+require "perka/model/sms_message"
+require "perka/model/social_service_subscription"
+require "perka/model/tier_traversal"
+require "perka/model/program_tier"
+require "perka/model/merchant_capability"
+require "perka/model/outbound_message"
+require "perka/model/canned_email_outbound_message"
+require "perka/model/console_message"
+require "perka/model/push_message"
+require "perka/model/sms_outbound_message"
+require "perka/model/coupon_visibility"
+require "perka/model/merchant_device"
+require "perka/model/street_address"
+require "perka/model/program"
+require "perka/model/reward_advancement"
+require "perka/model/abstract_reward_confirmation"
+require "perka/model/points_activity_confirmation"
+require "perka/model/punch_reward_confirmation"
+require "perka/model/redemption_coupon_confirmation"
+require "perka/model/redemption_reward_confirmation"
+require "perka/model/tier_traversal_confirmation"
+require "perka/model/coupon_redemption"
+require "perka/model/feedback_item"
+require "perka/model/parameter_description"
+require "perka/model/coupon"
+require "perka/model/coupon_target"
+require "perka/model/bounce_back_target"
+require "perka/model/composite_target"
+require "perka/model/everybody_target"
+require "perka/model/like_to_unlock_target"
+require "perka/model/first_visit_target"
+require "perka/model/idle_customer_target"
+require "perka/model/list_target"
+require "perka/model/participation_target"
+require "perka/model/social_list_target"
+require "perka/model/weather_target"
+require "perka/model/nobody_target"
+require "perka/model/physical_redemption_target"
+require "perka/model/tier_target"
+require "perka/model/yield_management_target"
+require "perka/model/program_type"
+require "perka/model/coupon_campaign"

data/perka.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/perka/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Joe Stelmach"]
+  gem.email         = ["joe@getperka.com"]
+  gem.description   = %q{Write a gem description}
+  gem.summary       = %q{Write a gem summary}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "perka"
+  gem.require_paths = ["lib"]
+  gem.version       = Perka::VERSION
+  
+  gem.add_development_dependency "rspec", "~> 2.6"
+  gem.add_dependency("flatpack_client", "=1.0.pre")
+end