active_merchant-epsilon 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de0b3aa4a30a45fb2382fd5ffc122fa5ee478aaa
+  data.tar.gz: 44fbd6b127ffcf0fa4d463928a697664d94d6f25
+SHA512:
+  metadata.gz: 1f7e2bafadd6cd3568cc254bf51d1191b2e4fb387f92ae48280ebecf7e8f4c646e0280bae804515d126b56c56d94ec410a9a3486e0245c78c64d6802f25901c9
+  data.tar.gz: cc2295750c7519d4fca101273b89ae1272c39988e2c28a84de1557517c6590fa93f19ece59f7701fe6d3da6f34b631fee08d92ce2739d06b009ff27c8c255993

data/.env.sample

@@ -0,0 +1,3 @@
+CONTRACT_CODE=00000000
+PROXY_ADDRESS=http://myproxy.com # if you need
+PROXY_PORT=8888 # if you need

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.env
+.ruby-version

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# CHANGELOG
+
+### 0.5.0
+
+* Separate ConvenienceStorePayment from EpsilonGateway and Create new gateway
+* Require user_name in detail for purchase method
+* Rename number_of_payments to payment_time
+* Remove ActiveMerchant::Epsilon::InvalidActionError
+* Remove ActiveMerchant::Epsilon::InvalidPaymentMethodError
+
+### 0.4.0
+
+* Support credit card installment payment
+* Support credit card revolving payment
+* Fix response of credit card payment with 3D secure
+* Remove raw_ssl_request method
+
+### 0.3.0
+
+* Support credit card payment with 3D secure
+* Disable to specify contract_code with purchase_detail
+
+### 0.2.0
+
+* Specification user_name with purchase_detail
+
+### 0.1.0
+
+* CreditCard verification_value is required by default

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_merchant-epsilon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 GMO Pepabo, Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,256 @@
+# ActiveMerchant::Epsilon
+[![wercker status](https://app.wercker.com/status/43c6648e20f325c8c0a560c36e89781c/s/master "wercker status")](https://app.wercker.com/project/bykey/43c6648e20f325c8c0a560c36e89781c)
+
+Epsilon integration for ActiveMerchant.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_merchant-epsilon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_merchant-epsilon
+
+## Usage
+
+### Settings
+
+An example Rails initializer would look something like this:
+
+```ruby
+ActiveMerchant::Billing::Base.mode = :production
+ActiveMerchant::Billing::EpsilonGateway.contract_code = '12345678'
+ActiveMerchant::Billing::EpsilonGateway.proxy_port = 8080
+ActiveMerchant::Billing::EpsilonGateway.proxy_address = 'myproxy.dev'
+```
+
+### CreditCard Payment
+
+```ruby
+require 'active_merchant'
+
+ActiveMerchant::Billing::Base.mode = :test
+
+ActiveMerchant::Billing::EpsilonGateway.contract_code = 'YOUR_CONTRACT_CODE'
+
+gateway = ActiveMerchant::Billing::EpsilonGateway.new
+
+amount = 10000
+
+ActiveMerchant::Billing::CreditCard.require_verification_value = true
+
+credit_card = ActiveMerchant::Billing::CreditCard.new(
+  first_name:         'TARO',
+  last_name:          'YAMADA',
+  number:             '4242424242424242',
+  month:              '10',
+  year:               Time.now.year + 1,
+  verification_value: '000', # security code
+)
+
+purchase_detail = {
+  user_id:      'YOUR_APP_USER_IDENTIFIER',
+  user_name:    '山田 太郎',
+  user_email:   'yamada-taro@example.com',
+  item_code:    'ITEM001',
+  item_name:    'Greate Product',
+  order_number: 'UNIQUE ORDER NUMBER',
+}
+
+if credit_card.validate.empty?
+  # Capture 10000 yen from the credit card
+  response = gateway.purchase(amount, credit_card, purchase_detail)
+
+  if response.success?
+    puts "Successfully charged #{amount} yen to the credit card #{credit_card.display_number}"
+  else
+    raise StandardError, response.message
+  end
+end
+```
+
+### CreditCard Payment with 3D secure
+
+```ruby
+amount = 10000
+
+ActiveMerchant::Billing::CreditCard.require_verification_value = true
+
+credit_card = ActiveMerchant::Billing::CreditCard.new(
+  first_name:         'TARO',
+  last_name:          'YAMADA',
+  number:             '4242424242424242',
+  month:              '10',
+  year:               Time.now.year + 1,
+  verification_value: '000', # security code
+)
+
+purchase_detail = {
+  user_id:                   'YOUR_APP_USER_IDENTIFIER',
+  user_name:                 '山田 太郎',
+  user_email:                'yamada-taro@example.com',
+  item_code:                 'ITEM001',
+  item_name:                 'Greate Product',
+  order_number:              'UNIQUE ORDER NUMBER',
+  three_d_secure_check_code: 1,
+}
+
+if credit_card.validate.empty?
+  response = gateway.purchase(amount, credit_card, purchase_detail)
+
+  raise StandardError, response.message unless response.success?
+
+  if response.params['three_d_secure']
+    puts response.params['acs_url']
+    puts response.params['pareq']
+  else
+    # NOT 3D SECURE
+    puts "Successfully charged #{amount} yen to the credit card #{credit_card.display_number}"
+  end
+end
+
+# (The card holder identifies himself on credit card's page and comes back here)
+
+# AND SECOND REQUEST
+
+response = gateway.authenticate(
+  order_number:         'ORDER NUMBER',
+  three_d_secure_pares: 'PAYMENT AUTHENTICATION RESPONSE',
+)
+
+if response.success?
+  puts "Successfully charged to the credit card"
+else
+  raise StandardError, response.message
+end
+```
+
+### CreditCard Installment Payment
+
+```ruby
+# (snip)
+
+purchase_detail = {
+  user_id:      'YOUR_APP_USER_IDENTIFIER',
+  user_name:    '山田 太郎',
+  user_email:   'yamada-taro@example.com',
+  item_code:    'ITEM001',
+  item_name:    'Greate Product',
+  order_number: 'UNIQUE ORDER NUMBER',
+  credit_type:  ActiveMerchant::Billing::EpsilonGateway::CreditType::INSTALLMENT,
+  payment_time: 3, # 3, 5, 6, 10, 12, 15, 18, 20, 24
+}
+
+# (snip)
+```
+
+### CreditCard Revolving Payment
+
+```ruby
+# (snip)
+
+purchase_detail = {
+  user_id:      'YOUR_APP_USER_IDENTIFIER',
+  user_name:    '山田 太郎',
+  user_email:   'yamada-taro@example.com',
+  item_code:    'ITEM001',
+  item_name:    'Greate Product',
+  order_number: 'UNIQUE ORDER NUMBER',
+  credit_type:  ActiveMerchant::Billing::EpsilonGateway::CreditType::REVOLVING,
+}
+
+# (snip)
+```
+
+### Convenience Store Payment
+
+```ruby
+ActiveMerchant::Billing::EpsilonConvenienceStoreGateway.contract_code = 'YOUR_CONTRACT_CODE'
+
+gateway = ActiveMerchant::Billing::EpsilonConvenienceStoreGateway.new
+
+convenience_store = ActiveMerchant::Billing::ConvenienceStore.new(
+  code:           ActiveMerchant::Billing::ConvenienceStore::Code::LAWSON,
+  full_name_kana: 'ヤマダ タロウ',
+  phone_nubmer:   '0312345678'
+)
+
+purchase_detail = {
+  user_id:      'YOUR_APP_USER_IDENTIFIER',
+  user_name:    '山田 太郎',
+  user_email:   'yamada-taro@example.com',
+  item_code:    'ITEM001',
+  item_name:    'Greate Product',
+  order_number: 'UNIQUE ORDER NUMBER',
+}
+
+if credit_card.validate.empty?
+  # 10000 yen as convenience store paymet
+  response = gateway.purchase(amount, convenience_store, purchase_detail)
+
+  if response.success?
+    puts "Successfully charged #{amount} yen as convenience store payment"
+    puts "Receipt number is #{response.params['receipt_number']}"
+    puts "Payment limit date is #{response.params['convenience_store_limit_date']}"
+  else
+    raise StandardError, response.message
+  end
+end
+```
+
+### Recurring Billing (Monthly subscritpion)
+
+```ruby
+purchase_detail[:mission_code] = ActiveMerchant::Billing::EpsilonGateway::MissionCode::RECURRING_6
+
+gateway.recurring(amount, creadit_card, purchase_detail)
+```
+
+### Cancel recurring billing
+
+```ruby
+gateway.cancel_recurring(user_id: 'user_id', item_code: 'item_code')
+```
+
+### Void Transaction
+
+```ruby
+gateway.void('order_number')
+```
+
+### Verify Credit Card
+
+```ruby
+gateway.verify(credit_card, user_id: 'user_id', user_email: 'user@example.com')
+```
+
+### Error handling
+
+If epsilon server returns status excepted 200, `#purchase` method raise `ActiveMerchant::ResponseError`.
+
+When your request parameters are wrong(e.g. contract_code), the method return failuer response.
+
+- `#success?` returns `false`
+- `#params` has error detail
+
+```ruby
+response = gateway.purchase(10000, creadit_card, invalid_detail)
+
+response.success? # => false
+response.params   # => Hash included error detail
+```
+
+## Contributing
+
+1. Create your feature branch (`git checkout -b my-new-feature`)
+2. Commit your changes (`git commit -am 'Add some feature'`)
+3. Push to the branch (`git push origin my-new-feature`)
+4. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc 'Run the unit test suite'
+task :defualt => 'test:unit'
+
+namespace :test do
+  Rake::TestTask.new(:unit) do |t|
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.libs << 'test'
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:remote) do |t|
+    t.pattern = 'test/remote/**/*_test.rb'
+    t.libs << 'test'
+    t.verbose = true
+  end
+end

data/active_merchant-epsilon.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_merchant/epsilon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_merchant-epsilon'
+  spec.version       = ActiveMerchant::Epsilon::VERSION
+  spec.authors       = ['Kenichi TAKAHASHI']
+  spec.email         = ['kenichi.taka@gmail.com']
+  spec.summary       = %q{Epsilon integration for ActiveMerchant.}
+  spec.description   = %q{Epsilon integration for ActiveMerchant.}
+  spec.homepage      = 'http://github.com/pepabo/active_merchant-epsilon'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activemerchant', '~> 1.48.0'
+  spec.add_dependency 'nokogiri'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'tapp'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr'
+end

data/lib/active_merchant/billing/convenience_store.rb

@@ -0,0 +1,55 @@
+module ActiveMerchant
+  module Billing
+    class ConvenienceStore < Model
+      module Code
+        SEVEN_ELEVEN = 11
+        FAMILY_MART  = 21
+        LAWSON       = 31
+        SEICO_MART   = 32
+      end
+
+      def initialize(code:, full_name_kana:, phone_number:)
+        @code           = code
+        @full_name_kana = full_name_kana
+        @phone_number   = phone_number
+      end
+
+      def code
+        @code
+      end
+
+      def name
+        @full_name_kana
+      end
+
+      def phone_number
+        @phone_number
+      end
+
+      def validate
+        errors_hash(validate_essential_attributes)
+      end
+
+      private
+
+      def validate_essential_attributes
+        errors = []
+
+        if code.blank?
+          errors << [:code, "is required"]
+        elsif !valid_code?(code)
+          errors << [:code, "is invalid"]
+        end
+
+        errors << [:full_name_kana, "is required"] if name.blank?
+        errors << [:phone_number, "is required"] if phone_number.blank?
+
+        errors
+      end
+
+      def valid_code?(code)
+        [SEVEN_ELEVEN, FAMILY_MART, LAWSON, SEICO_MART].include?(code.to_i)
+      end
+    end
+  end
+end