cashstar 0.1.2 → 0.1.3

data/README.md

@@ -22,6 +22,11 @@ A Ruby wrapper for the CashStar REST API
 	  config.endpoint = 'production or semi-production url'  
 	  config.format = 'json' #or 'xml'
 	end
+	
+	# Gift Card numbers are not returned by default - only urls to the hosted Gift Card and the associated challenge phrase
+	# If you need the gift card number and pin, include the following in your config block:
+	
+	config.return_card_numbers = true
 
     # Get all merchants enabled for this account
     puts Cashstar.merchants

data/lib/cashstar/client.rb

@@ -19,8 +19,6 @@ module Cashstar
     include Cashstar::Client::Faceplates
     include Cashstar::Client::Catalog
     include Cashstar::Client::OrderMethods
-    
-   
-            
+    include Cashstar::Client::GiftCardMethods          
   end
 end

data/lib/cashstar/client/gift_card.rb

@@ -2,6 +2,12 @@ require 'hashie'
 
 module Cashstar
   class Client
+    module GiftCardMethods
+      def balance_inquiry
+        true
+      end
+    end
+    
     # Defines methods related to a Cashstar Order
     class GiftCard < Hashie::Dash
       property :merchant_code, :required => true
@@ -11,8 +17,6 @@ module Cashstar
       property :challenge_description
       property :delivery
       property :message
-      
-      
     end
     
     class Delivery < Hashie::Dash

data/lib/cashstar/client/order.rb

@@ -8,6 +8,10 @@ module Cashstar
         response = post("/v2/order/", order.to_json)
         format.to_s.downcase == 'xml' ? response['order'] : response['order']
       end
+      
+      def return(order)
+        true
+      end
     end
      
     # Defines methods related to a Cashstar Order

data/lib/cashstar/configuration.rb

@@ -8,6 +8,7 @@ module Cashstar
       :username,
       :password,
       :endpoint,
+      :return_card_numbers,
       :format,
       :user_agent,
       :adapter,
@@ -26,6 +27,10 @@ module Cashstar
     #
     # @note This is configurable in case you want to connect to CashStar's test environment at https://api-semiprod.cashstar.com
     DEFAULT_ENDPOINT = 'https://api-semiprod.cashstar.com'.freeze
+    
+    # By default, we do not pass card numbers and pins back, only url's and challenge codes. This helps default to the most 
+    # secure mode of usage.
+    DEFAULT_RETURN_CARD_NUMBERS = false
 
     # The response format appended to the path and sent in the 'Accept' header if none is set
     #
@@ -49,6 +54,11 @@ module Cashstar
     def configure
       yield self
     end
+    
+    # Convienince method determining if pointed to the test env.
+    def test?
+      self.endpoint == DEFAULT_ENDPOINT
+    end
 
     # Create a hash of options and their values
     def options
@@ -66,6 +76,7 @@ module Cashstar
       self.format             = DEFAULT_FORMAT
       self.user_agent         = DEFAULT_USER_AGENT
       self.faraday_options    = DEFAULT_FARADAY_OPTIONS
+      self.return_card_numbers = DEFAULT_RETURN_CARD_NUMBERS
       self
     end
   end

data/lib/cashstar/connection.rb

@@ -3,6 +3,7 @@ require 'faraday/request/gateway'
 require 'faraday/request/basic_auth'
 require 'faraday/response/raise_http_4xx'
 require 'faraday/response/raise_http_5xx'
+require 'faraday/response/strip_card_numbers'
 
 module Cashstar
   # @private
@@ -24,6 +25,9 @@ module Cashstar
         builder.use Faraday::Request::BasicAuth, authentication if authenticated?
         builder.use Faraday::Request::UrlEncoded
         builder.use Faraday::Response::RaiseHttp4xx
+        unless return_card_numbers
+          builder.use Faraday::Response::StripCardNumbers 
+        end
         unless options[:raw]
           case options.fetch(:format, format).to_s.downcase
           when 'json'

data/lib/cashstar/version.rb

@@ -1,3 +1,3 @@
 module Cashstar
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/faraday/response/strip_card_numbers.rb

@@ -0,0 +1,12 @@
+require 'faraday'
+
+module Faraday
+  class Response::StripCardNumbers < Response::Middleware
+    
+    def parse(body)
+      body["order"]["egc"].delete("egc_number")
+      body["order"]["egc"].delete("access_code")
+      body
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cashstar
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-06 00:00:00.000000000Z
+date: 2011-10-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70158028059060 !ruby/object:Gem::Requirement
+  requirement: &70195147334480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70158028059060
+  version_requirements: *70195147334480
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70158028058320 !ruby/object:Gem::Requirement
+  requirement: &70195147331900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.7.4
   type: :runtime
   prerelease: false
-  version_requirements: *70158028058320
+  version_requirements: *70195147331900
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70158028057800 !ruby/object:Gem::Requirement
+  requirement: &70195147328580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *70158028057800
+  version_requirements: *70195147328580
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70158028057160 !ruby/object:Gem::Requirement
+  requirement: &70195147327440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70158028057160
+  version_requirements: *70195147327440
 - !ruby/object:Gem::Dependency
   name: multi_xml
-  requirement: &70158028056480 !ruby/object:Gem::Requirement
+  requirement: &70195147326540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70158028056480
+  version_requirements: *70195147326540
 description: CashStar's API provides a simple interface for purchasing and issuing
   electronic gift cards from a variety of brands
 email:
@@ -100,6 +100,7 @@ files:
 - lib/faraday/request/gateway.rb
 - lib/faraday/response/raise_http_4xx.rb
 - lib/faraday/response/raise_http_5xx.rb
+- lib/faraday/response/strip_card_numbers.rb
 homepage: http://www.cashstar.com
 licenses: []
 post_install_message: