didww_ups 0.1.0

data/lib/didww_ups/modules_base.rb

@@ -0,0 +1,27 @@
+# DidwwUps::Base class base class for API resources
+module DidwwUps
+  module ModulesBase
+
+    extend ActiveSupport::Concern
+
+    included do
+      self.prefix = "/api/rest/v1/logs/:module_name/"
+
+      def module_name
+        prefix_options[:module_name]
+      end
+
+      def duplicable?
+        false
+      end
+
+      def created_at
+        Time.parse(self[:created_at])
+      end
+
+
+    end
+
+
+  end
+end

data/lib/didww_ups/modules_payment.rb

@@ -0,0 +1,18 @@
+# Routes: /api/rest/v1/logs/:type/tokens(.:format)
+# Example
+#   DidwwUps::ModulesPayment.all(:params=> {:module_name=>'Braintree'})
+# #=> "[{"amount":"2054.0","created_at":"2014-03-13T14:04:06Z","id":134,"store_id":14,"success":false,"module_name":"Braintree","error":"Reversal amount does not match authorization amount"},{"amount":"42.0","created_at":"2014-03-13T14:01:08Z","id":133,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"16.0","created_at":"2014-03-13T13:56:29Z","id":132,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"91.0","created_at":"2014-03-13T13:27:56Z","id":131,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"10.0","created_at":"2014-03-13T13:24:07Z","id":130,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"10.0","created_at":"2014-03-13T13:21:38Z","id":129,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"10.0","created_at":"2014-03-13T13:15:26Z","id":128,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"10.0","created_at":"2014-03-13T13:13:34Z","id":127,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"10.0","created_at":"2014-03-13T13:09:32Z","id":126,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"50.0","created_at":"2014-03-13T12:57:57Z","id":125,"store_id":14,"success":true,"module_name":"Braintree","error":null}]"
+#
+
+module DidwwUps
+  class ModulesPayment < DidwwUps::Base
+    include DidwwUps::ModulesBase
+    self.element_name = 'payment'
+
+    def success
+      !!attributes[:success]
+    end
+
+  end
+
+end

data/lib/didww_ups/modules_refund.rb

@@ -0,0 +1,17 @@
+# Routes: /api/rest/v1/logs/:type/tokens(.:format)
+# Example
+#    DidwwUps::ModulesRefund.all(params: {module_name: "Braintree", :order => "created_at_desc"})
+# #=>"[{"amount":"34.91","created_at":"2013-12-17T14:09:14Z","id":31,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"12.0","created_at":"2013-12-13T15:07:28Z","id":29,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"10.0","created_at":"2013-12-07T09:07:28Z","id":28,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"23.0","created_at":"2013-12-05T17:05:03Z","id":27,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"50.0","created_at":"2013-12-05T12:40:11Z","id":26,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"31.21","created_at":"2013-12-05T10:09:17Z","id":25,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"12.0","created_at":"2013-12-05T09:53:53Z","id":24,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"12.0","created_at":"2013-12-05T09:27:31Z","id":23,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"34.0","created_at":"2013-11-18T13:55:28Z","id":15,"store_id":14,"success":true,"module_name":"Braintree","error":null},{"amount":"15.0","created_at":"2013-11-11T09:05:22Z","id":14,"store_id":14,"success":true,"module_name":"Braintree","error":null}]"
+#
+
+module DidwwUps
+  class ModulesRefund < DidwwUps::Base
+    include DidwwUps::ModulesBase
+    self.element_name = 'refund'
+
+
+    def success
+      !!attributes[:success]
+    end
+  end
+end

data/lib/didww_ups/modules_token.rb

@@ -0,0 +1,14 @@
+# Routes: /api/rest/v1/logs/:type/tokens(.:format)
+# Example
+#    DidwwUps::ModulesToken.all(params: {module_name: "Braintree", :order => "created_at_desc"})
+
+module DidwwUps
+  class ModulesToken < DidwwUps::Base
+    include DidwwUps::ModulesBase
+    self.element_name = 'token'
+
+    def success
+      !!attributes[:success?]
+    end
+  end
+end

data/lib/didww_ups/payment.rb

@@ -0,0 +1,80 @@
+# DidwwUps::Payment class to handle Payments
+#
+# Routes:
+#   GET        /api/rest/v1/payments(.:format)
+#   POST      /api/rest/v1/payments(.:format)
+#
+# Filter Examples
+#   payments = DidwwUps::Payment.all(params: { page:1, per_page:10 , q:{success_eq: true}})
+#   # => GET "/api/rest/v1/payments?page=1&per_page=10&q%5Bsuccess_eq%5D=true"
+#
+#  Methods for pagination
+#   # payments.total_count
+#   # payments.limit_value
+#   # payments.offset_value
+#
+#
+# Possible filter keys for params[:q]
+#   * +created_at_gte+
+#   * +created_at_lte+
+#   * +amount_eq+
+#   * +cc_number_contains+
+#   * +order_id_eq+
+#   * +success_eq+
+#   * +store_id_eq+
+#   * +customer_id_eq+
+#
+# Create Payment
+#
+# Example failed by merchant
+#
+#   payment =  DidwwUps::Payment.create({token_ref: "LQ8IQ4Av6hM3tgX_WLJp9w", order_id: 7, amount: 20.01, operator: 'Admin', description: 'Payment for order # 7'})
+#   # => POST "/api/rest/v1/payments" "{\"order_id\":7,\"amount\":20.1,\"operator\":\"Admin\",\"description\":\"Payment for order # 7\",\"token_ref\":\"LQ8IQ4Av6hM3tgX_WLJp9w\"}"
+#   # => "{\"id\":1967,\"token_ref\":\"LQ8IQ4Av6hM3tgX_WLJp9w\",\"cc_type\":\"MASTERCARD\",\"cc_number\":\"540400******0001\",\"success\":false,\"error\":\"Declined\",\"amount\":20.5,\"order_id\":7,\"description\":\"Payment for order # 7\",\"operator\":\"Admin\",\"type\":\"WorldnetTps\"}"
+#   payment.valid?   # => true
+#   payment.success? # => false
+#
+# Example failed by UPS
+#
+#   payment =  DidwwUps::Payment.create({token_ref: "LQ8IQ4Av6hM3tgX_WLJp9w", order_id: 6, amount: 20.60, operator: 'Admin', description: 'Payment for order # 6'})
+#   # => "{\"errors\":{\"base\":[\"Order was already processed\"]}}"
+#   payment.success? # => false
+#   payment.valid?   #  => false
+#   errors.full_messages  # => ["Order was already processed"]
+#
+# Example successfull
+#
+#   payment =  DidwwUps::Payment.create({token_ref: "LQ8IQ4Av6hM3tgX_WLJp9w",order_id: 8, amount: 20.50, operator: 'Admin', description: 'Payment for order # 8'})
+#   # => "{\"id\":1968,\"token_ref\":\"LQ8IQ4Av6hM3tgX_WLJp9w\",\"cc_type\":\"MASTERCARD\",\"cc_number\":\"540400******0001\",\"success\":true,\"error\":null,\"amount\":20.5,\"order_id\":8,\"description\":\"Payment for order # 8\",\"operator\":\"Admin\",\"type\":\"WorldnetTps\"}"
+#   payment.success?  # => true
+#   payment.valid?    # =>  true
+#
+#
+#
+module DidwwUps
+  class Payment < DidwwUps::Base
+
+    def created_at
+      Time.parse(self[:created_at])
+    end
+
+    def success?
+      valid? && persisted? && success
+    end
+
+    #
+    # Creates refund from payment
+    #
+    # Params
+    # * +:amount+ - amount of refund,  if not present payment amount is used
+    # * +:description+ - Description of refund,  if not present payment description is used
+    # * +:operator+ - responsible for refund,  if not present payment operator is used
+    #
+    #
+    def refund(params={})
+      params = {amount: self.amount, description: self.description, operator: self.operator}.merge(params).merge({order_id: self.order_id})
+      DidwwUps::Refund.create(params)
+    end
+
+  end
+end

data/lib/didww_ups/railtie.rb

@@ -0,0 +1,7 @@
+module DidwwUps
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      DidwwUps.configure(Rails.env)
+    end
+  end
+end

data/lib/didww_ups/refund.rb

@@ -0,0 +1,65 @@
+# DidwwUps::Refund class to handle Refunds
+#
+# Routes:
+#   GET        /api/rest/v1/refunds(.:format)
+#   POST       /api/rest/v1/refunds(.:format)
+#
+# Filter Examples
+#   refunds = DidwwUps::Refund.all(params: { page:1, per_page:10 , q:{success_eq: true}})
+#   # => GET "/api/rest/v1/refunds?page=1&per_page=10&q%5Bsuccess_eq%5D=true"
+#
+# Methods for pagination
+#   # refunds.total_count
+#   # refunds.limit_value
+#   # refunds.offset_value
+#
+#
+# Possible filter keys for params[:q]
+#    * +:created_at_gte+
+#    * +:created_at_lte+
+#    * +:store_id_eq+
+#    * +:amount_eq+
+#    * +:description_contains+
+#    * +:operator_contains+
+#    * +:order_id_eq+
+#    * +:success_eq+
+#
+# Create Refund
+#
+# Example failed by merchant
+#   refund = DidwwUps::Refund.create(order_id: "1294526", amount:12.00, operator: "Bob", description: "Stolen Card")
+#   # => "{\"id\":466,\"success\":false,\"Credit Card is expired\":null,\"amount\":12.0,\"order_id\":\"1294526\",\"description\":\"Stolen Card\",\"operator\":\"Bob\"}"
+#   refund.valid?   # => true
+#   refund.success? # => false
+#
+# Example failed by UPS
+#   refund = DidwwUps::Refund.create(order_id: "1294526", amount:1000.00, operator: "Bob", description: "Stolen Card")
+#   # => "{\"errors\":{\"amount\":[\"must be less or equal to 14.0\"]}}"
+#   refund.success? # => false
+#   refund.valid?   #  => false
+#   errors.full_messages  #  => ["Amount must be less or equal to 14.0"]
+#
+# Example successfull
+#   refund = DidwwUps::Refund.create(order_id: "1294526", amount:12.00, operator: "Bob", description: "Stolen Card")
+#   # => "{\"id\":466,\"success\":true,\"error\":null,\"amount\":12.0,\"order_id\":\"1294526\",\"description\":\"Stolen Card\",\"operator\":\"Bob\"}"
+#   refund.success?  # => true
+#   refund.valid?    # =>  true
+#
+# Params
+# * +:amount+ - amount of refund,  if not present payment amount is used
+# * +:description+ - Description of refund,  if not present payment description is used
+# * +:operator+ - responsible for refund,  if not present payment operator is used
+# * +:order_id+ - order_id  of payment
+#
+module DidwwUps
+  class Refund < DidwwUps::Base
+
+    def created_at
+      Time.parse(self[:created_at])
+    end
+
+    def success?
+      valid? && persisted? && success
+    end
+  end
+end

data/lib/didww_ups/store.rb

@@ -0,0 +1,119 @@
+# DidwwUps::Store class with Store used as API client
+module DidwwUps
+  class Store < DidwwUps::Base
+
+    NEW_CREDIT_CARD_PATH = '/api/iframe/new'
+    APPEND_CREDIT_CARD_PATH = '/api/iframe/append'
+
+    class InvalidRequest < StandardError
+
+    end
+
+    # Retrieves profile information for current store
+    #   profile = DidwwUps::Store.profile
+    #   # => "{\"api_public_key\":\"somekey\",\"api_secret_key\":\"somesecret\",\"callback_url\":\"http://yoursite.com/callback.php\",\"created_at\":\"2012-12-24T11:03:36Z\",\"enabled\":true,\"id\":1,\"ip\":null,\"name\":\"mystore\",\"terminal_id\":1,\"updated_at\":\"2013-01-09T12:27:01Z\",\"details\":{\"terminal_id\":1,\"currency_sign\":\"USD\",\"modules\":[\"Stripe\",\"Braintree\"]}}"
+
+    def self.profile
+      self.get(:profile)
+    end
+
+
+    # Builds new uri for customer to enter credit card info
+    #
+    # * *Returns* :  URI::HTTPS object
+    # Example
+    #   <URI::HTTPS:0x007fa62377cfb0 URL:https://google.com/api/iframe/new?customer_id=1&date_time=2014-06-05+21%3A30%3A46&hash=4452d71687b6bc2c9389c3349fdc17fbd73b833b&public_key=public>
+    #    * +customer_id+ - unique string for customer or customer/credit-card combination
+    #    * +card_id+ - card id unique for customer_id
+    #    * +date_time+ - current utc datetime
+    #    * +public_key+ - public api key number
+    #    * +hash+ - SHA1 of next string  = api_secret_key+date_time+customer_id+ card_id
+
+    def new_credit_card_uri(customer_id,  options = {})
+       credit_card_uri(NEW_CREDIT_CARD_PATH, customer_id, options)  
+    end
+
+
+      def append_credit_card_uri(customer_id,  options = {})
+        credit_card_uri(APPEND_CREDIT_CARD_PATH, customer_id, options)     
+      end
+   
+
+    def credit_card_uri(path, customer_id, options)
+       URI::HTTPS.build(host: DidwwUps.service_host,
+                         path: path,
+                         query: credit_card_params(customer_id, options).to_query)
+    end
+
+    def credit_card_params(customer_id, options = {})
+      date_time = formatted_date_time
+      card_id = options.has_key?(:card_id) ? options.delete(:card_id) : nil
+      signed_hash = new_credit_card_uri_hash(customer_id, card_id, date_time)
+      options.merge({customer_id: customer_id,
+                                card_id: card_id,
+                                date_time: date_time,
+                                public_key: self['api_public_key'],
+                                hash: signed_hash })
+    end
+
+    #
+    #  Build credit card instance from callback uri params
+    #
+    # Params
+    # * +success+ - 0/1 (1 - YES)
+    # * +credit_card_expired+ - (credit card expiration YEAR-month)
+    # * +credit_card_number+ - (masked card number)
+    # * +credit_card_type+ - (credit card type upcased)
+    # * +customer_id+ - (customer id, that opened  the iframe  -  check if  currently logged in )
+    # * +date_time+ - UTC datetime  (2014-06-06:09:19:16:000)
+    # * +result+ - =error string if success equal to 0 , credit card ups token other-way.
+    # * +secure_hash+ - SHA1 of result + success + customer_id + date_time + api_secret_key
+    #
+    # Example  success
+    #   #card_id=1&credit_card_expired=2020-06&credit_card_number=540400%2A%2A%2A%2A%2A%2A0001&credit_card_type=MASTERCARD&customer_id=test&date_time=2014-06-06%3A09%3A19%3A16%3A000&result=4UHSmRkBMhWtHloKQfkjVQ&secure_hash=e4817a8fdb5885248c5f6c6044f4c8707016f013&store=worldnet&success=1
+    # Example failed
+    #   #credit_card_expired=&credit_card_number=&credit_card_type=&customer_id=1&date_time=2014-06-06%3A08%3A12%3A35%3A000&result=AVS+FAILURE&secure_hash=b5d63a10ca10e086dd3e087975b7eff4883f0216&success=0
+    def retrieve_credit_card(params= {})
+
+      DidwwUps::CreditCard.new({
+                                   result: params["result"],
+                                   customer_id: params['customer_id'],
+                                   credit_card_expired: params['credit_card_expired'],
+                                   credit_card_type: params['credit_card_type'],
+                                   store_id: self.id,
+                                   credit_card_number: params['credit_card_number'],
+                                   secure_hash: params['secure_hash'],
+                                   date_time: params['date_time'],
+                                   success: params['success'],
+                                   card_id: params['card_id']
+                               })
+
+    end
+
+    # raises InvalidRequest
+    def retrieve_credit_card!(params)
+      credit_card = retrieve_credit_card(params)
+      raise InvalidRequest.new(credit_card.errors.full_messages.join(",")) unless credit_card.valid?
+      credit_card
+    end
+
+    # method to generate authorization header token value
+    def request_token(path, method)
+      date_time = formatted_date_time
+
+      sign = Digest::SHA1.hexdigest "#{self['api_secret_key']}#{date_time}#{method.to_s.upcase}#{path}"
+      "#{Base64.urlsafe_encode64("#{self['api_public_key']}:#{sign}").strip}, date_time=#{date_time},type=v1"
+    end
+
+    def new_credit_card_uri_hash(customer_id, card_id, date_time)
+      Digest::SHA1.hexdigest(self['api_secret_key'] + date_time + customer_id.to_s + card_id.to_s)
+    end
+
+    protected
+
+    def formatted_date_time
+      Time.now.utc.strftime("%F %T")
+    end
+
+  end
+end

data/lib/didww_ups/version.rb

@@ -0,0 +1,3 @@
+module DidwwUps
+  VERSION = "0.1.0"
+end

data/lib/generators/config.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+module DidwwUps
+  class ConfigGenerator < Rails::Generators::Base
+    desc "Generates didww_ups.yml config file in application config directory"
+
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def generate_config
+      copy_file "didww_ups.yml", "config/didww_ups.yml"
+    end
+
+  end
+end

data/lib/generators/templates/didww_ups.yml

@@ -0,0 +1,14 @@
+production:
+  ups_env:  'sandbox'
+  store_public_key: 'production-publickey'
+  store_secret_key: 'production-secret'
+
+development:
+  ups_env:  'sandbox'
+  store_public_key: 'development-publickey'
+  store_secret_key: 'development-secretkey'
+
+test:
+  ups_env:  'sandbox'
+  store_public_key: 'test-publickey'
+  store_secret_key: 'test-secretkey'

data/spec/credit_card_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+describe DidwwUps::CreditCard do
+  before do
+
+    @path = DidwwUps::CreditCard.site.to_s + DidwwUps::CreditCard.prefix.to_s
+    @credit_card = DidwwUps::CreditCard.new({
+                                                token_ref: 'LQ8IQ4Av6hM3tgX_WLJp9w'
+                                            }, true)
+  end
+
+  context "Has properties" do
+    before do
+      @properties = {
+          bin: "510510",
+          bank: "BANK OF HAWAII",
+          country: "UNITED STATES",
+          card_brand: "MASTERCARD",
+          card_type: "CREDIT",
+          bank_phone: "1-888-643-3888 OR 1-888-643-9888",
+          customer_ip: "195.138.65.189",
+          fraud_level: nil}
+
+      properties_uri_template = Addressable::Template.new @path + 'credit_cards/{id}/properties'
+
+
+      stub_request(:get, properties_uri_template).to_return(body: @properties.to_json)
+
+    end
+
+    it "should respond to #properties and return credit card's properities" do
+      expect(@credit_card.properties).to eq(@properties.stringify_keys)
+    end
+
+  end
+
+  context "Has billing address" do
+    before do
+      @billing_address = {
+          bill_first_name: "FirstName",
+          bill_last_name: "SecondName",
+          city: "Odessa",
+          company: "",
+          country: "UA",
+          created_at: "2014-03-27T12:29:43Z",
+          email: "olga@gmail.com",
+          fax_number: "",
+          first_address_line: "Address line1",
+          id: 1070,
+          phone_number: "3806600000000",
+          second_address_line: "Address line2",
+          state: nil,
+          updated_at: "2014-03-27T12:29:43Z",
+          zip: "65007",
+          avs_result: nil
+      }
+
+      address_uri_template = Addressable::Template.new @path + 'credit_cards/{id}/billing_address'
+      stub_request(:get, address_uri_template).to_return(body: @billing_address.to_json)
+    end
+    it "should respond to #billign_address and return credit card's billing address" do
+      expect(@credit_card.billing_address).to eq(@billing_address.stringify_keys)
+    end
+  end
+
+  context "Has modules" do
+
+    before do
+      @modules = ['Stripe', 'Braintree']
+
+      modules_uri_template = Addressable::Template.new @path + 'credit_cards/{id}/modules'
+      stub_request(:get, modules_uri_template).to_return(body: @modules.to_json)
+    end
+
+    it "should respond to #modules and return credit card's modules" do
+      expect(@credit_card.modules).to eq(@modules)
+    end
+  end
+
+
+  context "Read Collection" do
+    before do
+      @collection = [
+          {token_ref: 'LQ8IQ4Av6hM3tgX_WLJp9w', credit_card_number: '555555******4444', credit_card_type: 'MASTERCARD', credit_card_expired: '2014-05', store_id: 1, customer_id: 1},
+          {token_ref: 'LQ8IQ4Av6hM3tgX_WLJp9E', credit_card_number: '401288******1881', credit_card_type: 'VISA', credit_card_expired: '2015-09', store_id: 1, customer_id: 2}
+      ]
+      @collection_headers = {'X-Total-Count' => '10', 'X-Offset-Value' => '0', 'X-Limit-Value' => '2'}
+      stub_request(:get, @path + 'credit_cards?page=1&per_page=2').to_return(body: @collection.to_json, headers: @collection_headers)
+    end
+
+    it "should be success" do
+      credit_cards = DidwwUps::CreditCard.all(params: {page: 1, per_page: 2})
+      expect(credit_cards.count).to eq(2)
+      expect(credit_cards.total_count).to eq(@collection_headers['X-Total-Count'].to_i)
+      expect(credit_cards.offset_value).to eq(@collection_headers['X-Offset-Value'].to_i)
+      expect(credit_cards.limit_value).to eq(@collection_headers['X-Limit-Value'].to_i)
+
+    end
+  end
+
+end