nihaopay-ruby 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 793d37f1e49e2b37efecb06a13c62cac1e2ddacf
-  data.tar.gz: 7cbd9cde59ba17ce779fc907e640d9181fa40372
+  metadata.gz: 6e27c0c50ef8f7cec23c8f238997b05a684e3112
+  data.tar.gz: 49ae05f6f7d2c446ff854fe3bd038ea7f6546568
 SHA512:
-  metadata.gz: 21b972bb2b50c3c762318dddc4031c8e86fb37bfa9047f0e8a2682b3fff02c9c2af597634fde833e1dda50cde933a0bea9bc84014759006633b02ffec195adce
-  data.tar.gz: 00947d8dbe1f6277928fc7b3ffcc40b00dd8af5222d3ae9f3cdade7aeb1db4ece12485b729e34015a5dfde2d1d7b00c3e52fa636af589c2c14263a5a6869cfa3
+  metadata.gz: e2db81aac7112fa455519986ff3abb16ada295a9029468d6279be5de21b83b963721c0da77bcc4de26e6d6f0f60e57458ba789ab7656a828ae6fa550c473b66f
+  data.tar.gz: 1d178cb769e8462af6f0d4ccd7b85f6287e0608e480c18d099925f5823a017508a22e4a36e399fd562d86772504c2e48ce88049a8d89ad37e90074a33f9e5cec

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.2.0
+
+* API Change: Time should be returned as a Ruby time object (@JagdeepSingh)
+
 ## 0.1.1
 
 * Bug Fix: Add time to Nihaopay response if not present (@JagdeepSingh)

data/README.md

@@ -146,7 +146,7 @@ express_pay.reference        # => "3461fcc31aec471780ad1a4dc6111947"
 express_pay.currency         # => "JPY"
 express_pay.amount           # => 1000
 express_pay.captured         # => false
-express_pay.time             # => "2017-01-17T17:51:00+0900"
+express_pay.time             # => 2017-01-18 12:08:42 +0900
 ```
 
 Other methods available are `note` and `time`.
@@ -180,7 +180,7 @@ captured.transaction_id           # => "20160718111604002633"
 captured.status                   # => "success"
 captured.captured                 # => true
 captured.capture_transaction_id   # => "20160718111529002632" (id of the transaction that was captured)
-captured.time                     # => "2017-01-17T17:51:00+0900"
+captured.time                     # => 2017-01-18 12:08:42 +0900
 ```
 
 If you want to capture a partial amount, you can do:
@@ -201,7 +201,7 @@ released.transaction_id           # => "20160718111604002633"
 released.status                   # => "success"
 released.released                 # => true
 released.release_transaction_id   # => "20160718111529002632" (id of the transaction that was released)
-released.time                     # => "2017-01-17T17:51:00+0900"
+released.time                     # => 2017-01-18 12:08:42 +0900
 ```
 
 #### Cancel a transaction
@@ -212,7 +212,7 @@ cancelled.transaction_id            # => "20160718111604002633"
 cancelled.status                    # => "success"
 cancelled.cancelled                 # => true
 cancelled.cancel_transaction_id     # => "20160718111529002632" (id of the transaction that was cancelled)
-cancelled.time                      # => "2017-01-17T17:51:00+0900"
+cancelled.time                      # => 2017-01-18 12:08:42 +0900
 ```
 
 Transactions can only be cancelled before the daily settlement deadline. Transactions cannot be cancelled if a partial or full refund on the transaction has already been issued.
@@ -234,23 +234,27 @@ By default, only 10 transactions are returned at a time. This can be adjusted by
 transactions = Nihaopay::Transactions::Base.limit(5).fetch
 ```
 
-To retrieve transactions that were processed after the specified time, you can all `after` with time in *yyyy-mm-ddThh:mm:ssZ* format.
+To retrieve transactions that were processed after the specified time, you can all `after` with `Time` object.
 
 ``` ruby
-transactions = Nihaopay::Transactions::Base.after('2016-06-01T01:00:00Z').fetch
+yesterday = Time.now - 24 * 60 * 60
+transactions = Nihaopay::Transactions::Base.after(yesterday).fetch
 ```
 
 Similarly, you can fetch the transactions that were processed before the specified time.
 
 ``` ruby
-transactions = Nihaopay::Transactions::Base.before('2016-06-01T01:00:00Z').fetch
+yesterday = Time.now - 24 * 60 * 60
+transactions = Nihaopay::Transactions::Base.before(yesterday).fetch
 ```
 
 You can chain methods to use multiple options:
 
 ``` ruby
-transactions = Nihaopay::Transactions::Base.before('2016-07-01T01:00:00Z')
-                                           .after('2016-06-01T01:00:00Z')
+yesterday = Time.now - 24 * 60 * 60
+week_ago = Time.now - 7 * 24 * 60 * 60
+transactions = Nihaopay::Transactions::Base.before(yesterday)
+                                           .after(week_ago)
                                            .limit(5).fetch
 ```
 
@@ -259,8 +263,10 @@ OR
 you can pass the options to `fetch`:
 
 ``` ruby
-transactions = Nihaopay::Transactions::Base.fetch(before: '2016-07-01T01:00:00Z',
-                                                  after: '2016-06-01T01:00:00Z',
+yesterday = Time.now - 24 * 60 * 60
+week_ago = Time.now - 7 * 24 * 60 * 60
+transactions = Nihaopay::Transactions::Base.fetch(before: yesterday,
+                                                  after: week_ago,
                                                   limit: 5)
 ```
 
@@ -289,7 +295,7 @@ refunded.transaction_id            # => "20160718111604002633"
 refunded.status                    # => "success"
 refunded.refunded                  # => true
 refunded.refund_transaction_id     # => "20160718111529002632" (id of the transaction that was refunded)
-refunded.time                      # => "2017-01-17T17:51:00+0900"
+refunded.time                      # => 2017-01-18 12:08:42 +0900
 ```
 
 You can pass a `reason` when refunding a transaction:

data/lib/nihaopay/mixins/queryable.rb

@@ -1,5 +1,7 @@
 module Nihaopay
   module Queryable
+    TIME_FORMAT = '%Y-%m-%dT%H:%M:%S%z'.freeze
+
     def self.included(base)
       base.extend(ClassMethods)
     end
@@ -14,8 +16,8 @@ module Nihaopay
       end
 
       def fetch(options = {})
-        options[:starting_after] = options.delete(:after) if options[:after]
-        options[:ending_before] = options.delete(:before) if options[:before]
+        options[:starting_after] = options.delete(:after).strftime(TIME_FORMAT) if options[:after]
+        options[:ending_before] = options.delete(:before).strftime(TIME_FORMAT) if options[:before]
         q.fetch(options)
       end
 
@@ -24,11 +26,11 @@ module Nihaopay
       end
 
       def before(time)
-        q.before(time)
+        q.before(time.strftime(TIME_FORMAT))
       end
 
       def after(time)
-        q.after(time)
+        q.after(time.strftime(TIME_FORMAT))
       end
 
       private

data/lib/nihaopay/transactions/base.rb

@@ -4,8 +4,6 @@ module Nihaopay
       include ::Nihaopay::Api
       include ::Nihaopay::Queryable
 
-      TIME_FORMAT = '%Y-%m-%dT%H:%M:%S%z'.freeze
-
       attr_accessor :token, :transaction_id, :type, :status
       attr_accessor :captured, :reference, :currency, :amount, :note, :time
 
@@ -57,7 +55,7 @@ module Nihaopay
           options = Nihaopay::HashUtil.symbolize_keys(options)
           attributes = Nihaopay::HashUtil.slice(options, *valid_attributes)
           attributes[:token] ||= merchant_token
-          attributes[:time] ||= Time.now.strftime(TIME_FORMAT)
+          attributes[:time] = attributes[:time] ? Time.parse(attributes[:time]) : Time.now
           response_keys_map.each { |k, v| attributes[v] = options[k] }
           new(attributes)
         end

data/lib/nihaopay/version.rb

@@ -1,3 +1,3 @@
 module Nihaopay
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/spec/mixins/queryable_spec.rb

@@ -65,14 +65,14 @@ describe Nihaopay::Queryable do
       let(:q) { Nihaopay::Query.new }
 
       context 'when :after present in options' do
-        let(:options) { { after: '2016-06-01T01:00:00Z', limit: 5 } }
-        it { expect(q).to receive(:fetch).with(starting_after: '2016-06-01T01:00:00Z', limit: 5) }
+        let(:options) { { after: Time.parse('2016-06-01T01:00:00Z'), limit: 5 } }
+        it { expect(q).to receive(:fetch).with(starting_after: '2016-06-01T01:00:00+0000', limit: 5) }
         after { Nihaopay::Transactions::Base.fetch(options) }
       end
 
       context 'when :before present in options' do
-        let(:options) { { before: '2016-06-01T01:00:00Z', limit: 5 } }
-        it { expect(q).to receive(:fetch).with(ending_before: '2016-06-01T01:00:00Z', limit: 5) }
+        let(:options) { { before: Time.parse('2016-06-01T01:00:00Z'), limit: 5 } }
+        it { expect(q).to receive(:fetch).with(ending_before: '2016-06-01T01:00:00+0000', limit: 5) }
         after { Nihaopay::Transactions::Base.fetch(options) }
       end
 

data/spec/transactions/base_spec.rb

@@ -142,7 +142,7 @@ describe Nihaopay::Transactions::Base do
       it { expect(subject.transaction_id).to eq '123456' }
       it { expect(subject.token).to eq 'merchanttoken2' }
       it { expect(subject.captured).to be true }
-      it { expect(subject.time).to eq '2016-06-01T01:00:00Z' }
+      it { expect(subject.time).to eq Time.parse('2016-06-01T01:00:00Z') }
     end
 
     context 'with options with string keys' do
@@ -176,9 +176,10 @@ describe Nihaopay::Transactions::Base do
         opts.delete(:time)
         opts
       end
-      before { allow(Time).to receive_message_chain(:now, :strftime) { '2017-01-17T16:00:00+0900' } }
+      let!(:now) { Time.now }
+      before { allow(Time).to receive(:now) { now } }
       subject { described_class.build(options) }
-      it { expect(subject.time).to eq '2017-01-17T16:00:00+0900' }
+      it { expect(subject.time).to eq now }
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nihaopay-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - JagdeepSingh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-17 00:00:00.000000000 Z
+date: 2017-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty