omise 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb0747d2916db26b8867f729d2fc45ec8c0ae298
-  data.tar.gz: 6f32be4761236faaca1495948d8bd4abe33581c0
+  metadata.gz: 26de59160d14b03572bf1697765e0055033bde51
+  data.tar.gz: df763a37a7abeb4f5b8dcf547e6a2042370437ab
 SHA512:
-  metadata.gz: 5f0cdda6e658f79be9a7056e2f49d5a634cb8cb74664b2e54753bce1d36ff8c6e3120e5c4f69536dac1ed4fb9d0124516e2c8ba838a50a0351beaa16ea1458d6
-  data.tar.gz: 6fbba84db39bfe3efbf8085b82c2c32931d913745b972299e8d4560a86abbab9f02c82cab48e70f4dfbaa878e18274b0c58e88bf1254d1a9069782c6981eeed3
+  metadata.gz: de7f8dab27de2aacf55c78f55d067c8eb31eec125b05db1a21c150b7229a459f347342a59c23c5b8ac89668a8a47770f24ddf4ed5da8ed071338b4448b347512
+  data.tar.gz: 3f48a5677710a2126aa4af36d38891a2488cc10ba673558c1696f73b5be9a8830130a1d31057ebe3aa3bacfbce6d2004ee02d81b96369df27b1a1e43df30c724

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 An [unreleased] version is not available on rubygems and is subject to changes and must not be considered final. Elements of unreleased list may be edited or removed at any time.
 
+## [unreleased]
+
+- [Added] Support to log HTTP requests and responses.
+- [Added] Rename keys with better names while supporting old methods
+- [Fix] Avoid circular require warnings when running tests
+
 ## [0.5.0] 2016-11-26
 
 - [Added] Add search object and filtering api

data/README.md

@@ -7,7 +7,7 @@
 
 ## Installation
 
-Installing via rubgems:
+Installing via rubygems:
 
 ```ruby
 gem 'omise'
@@ -21,7 +21,7 @@ gem 'omise', github: 'omise/omise-ruby'
 
 ## Requirements
 
-Requires ruby 1.9.2 or above, the rest-client and json gem.
+Requires ruby 1.9.2 or above, the rest-client and json gems.
 
 ## Configuration
 
@@ -34,20 +34,20 @@ Omise.api_key = "skey_test_xxxxxxxxxxxxxxxxxxx"
 If you need to use the Token API you also need to set your public key:
 
 ```ruby
-Omise.vault_key = "pkey_test_xxxxxxxxxxxxxxxxxxx"
+Omise.public_api_key = "pkey_test_xxxxxxxxxxxxxxxxxxx"
 ```
 
 With this set you'll be able to retrieve tokens or create new ones.
 
-However we recommend using [Omise.js](https://gitub.com/omise/omise.js) to
-create tokens. When creating a token server side you'll need card data
+However we recommend using [Omise.js](https://github.com/omise/omise.js) to
+[collect cards](https://www.omise.co/collecting-card-information). When creating a token server side you'll need card data
 transiting to and from your server and this requires that your organization be
 PCI compliant.
 
 ### API version
 
 In case you want to enforce API version the application use, you can specify it
-by setting the api_version. The version specified by this settings will override
+by setting the `api_version`. The version specified by this settings will override
 the version setting in your account. This is useful if you have multiple
 environments with different API versions (e.g. development on the latest but
 production on the older version).
@@ -60,6 +60,18 @@ Omise.api_version = "2014-07-27"
 It is highly recommended to set this version to the current version
 you're using.
 
+### Logging
+
+To enable log you can set `Omise.logger` with a Ruby logger. All HTTP requests and responses will be logged.
+
+To disable log, just configure `Omise.logger` to `nil`. Default is disabled.
+
+An example configuring Rails logger:
+
+```ruby
+Omise.logger = Rails.logger
+```
+
 ## Quick Start
 
 After you have implemented [Omise.js](https://gitub.com/omise/omise.js) on your

data/bin/console

@@ -3,7 +3,7 @@
 require "bundler/setup"
 require "omise"
 
-Omise.api_key = ENV["OMISE_API_KEY"]
+Omise.secret_api_key = ENV["OMISE_API_KEY"]
 
 require "pry"
 Pry.start

data/lib/omise/all.rb

@@ -1,5 +1,6 @@
 require "omise/account"
 require "omise/balance"
+require "omise/bank_account"
 require "omise/card"
 require "omise/charge"
 require "omise/customer"

data/lib/omise/card_list.rb

@@ -1,14 +1,20 @@
 require "omise/list"
-require "omise/card"
-require "omise/token"
 
 module Omise
   class CardList < List
     def retrieve(id, attributes = {})
+      if !defined?(Card)
+        require "omise/card"
+      end
+
       Card.new self.class.resource(location(id), attributes).get(attributes)
     end
 
     def create(attributes = {})
+      if !defined?(Token)
+        require "omise/token"
+      end
+
       token = Token.create(card: attributes)
       parent.update(card: token.id)
       retrieve(token.card.id)

data/lib/omise/charge.rb

@@ -1,10 +1,7 @@
 require "omise/object"
 require "omise/list"
-require "omise/customer"
-require "omise/dispute"
 require "omise/refund_list"
 require "omise/search_scope"
-require "omise/transaction"
 
 module Omise
   class Charge < OmiseObject
@@ -43,14 +40,26 @@ module Omise
     end
 
     def customer(options = {})
+      if !defined?(Customer)
+        require "omise/customer"
+      end
+
       expand_attribute Customer, "customer", options
     end
 
     def dispute(options = {})
+      if !defined?(Dispute)
+        require "omise/dispute"
+      end
+
       expand_attribute Dispute, "dispute", options
     end
 
     def transaction(options = {})
+      if !defined?(Transaction)
+        require "omise/transaction"
+      end
+
       expand_attribute Transaction, "transaction", options
     end
 

data/lib/omise/config.rb

@@ -1,35 +1,58 @@
+require "omise/http_logger"
 require "omise/resource"
 
 module Omise
+  LIB_PATH = File.expand_path("../../", __FILE__)
+
   class << self
-    attr_writer :api_key, :vault_key
     attr_accessor :api_url, :vault_url, :api_version, :resource
 
-    def api_key
-      get_key :api
+    attr_writer :secret_api_key, :public_api_key
+
+    def secret_api_key
+      get_key :secret_api_key
     end
 
-    def vault_key
-      get_key :vault
+    def public_api_key
+      get_key :public_api_key
+    end
+
+    # Backward compatibility with old API Keys naming conventions
+    #
+    # Will be removed in 1.0
+    alias_method :api_key,    :secret_api_key
+    alias_method :api_key=,   :secret_api_key=
+    alias_method :vault_key,  :public_api_key
+    alias_method :vault_key=, :public_api_key=
+
+    def logger=(logger)
+      @http_logger = Omise::HTTPLogger.new(logger)
+    end
+
+    def http_logger
+      @http_logger ||= Omise::HTTPLogger.new
     end
 
     def test!
-      require "omise/testing/resource"
+      if !defined?(Omise::Testing::Resource)
+        require "omise/testing/resource"
+      end
+
       self.resource = Omise::Testing::Resource
     end
 
     private
 
     def get_key(name)
-      if key = instance_variable_get("@#{name}_key")
+      if key = instance_variable_get("@#{name}")
         key
       else
-        raise "Set Omise.#{name}_key to use this feature"
+        raise "Set Omise.#{name} to use this feature"
       end
     end
   end
 
-  self.api_url = "https://api.omise.co"
+  self.api_url   = "https://api.omise.co"
   self.vault_url = "https://vault.omise.co"
-  self.resource = Resource
+  self.resource  = Resource
 end

data/lib/omise/customer.rb

@@ -1,7 +1,6 @@
 require "omise/object"
-require "omise/card_list"
-require "omise/charge"
 require "omise/list"
+require "omise/card_list"
 require "omise/search_scope"
 
 module Omise
@@ -37,6 +36,10 @@ module Omise
     end
 
     def charge(attributes = {})
+      if !defined?(Charge)
+        require "omise/charge"
+      end
+
       Charge.create(attributes.merge(customer: id))
     end
 

data/lib/omise/dispute.rb

@@ -1,7 +1,6 @@
 require "omise/object"
-require "omise/charge"
-require "omise/document_list"
 require "omise/list"
+require "omise/document_list"
 require "omise/search_scope"
 
 module Omise
@@ -30,6 +29,10 @@ module Omise
     end
 
     def charge(options = {})
+      if !defined?(Charge)
+        require "omise/charge"
+      end
+
       expand_attribute Charge, "charge", options
     end
 

data/lib/omise/document_list.rb

@@ -1,13 +1,20 @@
-require "omise/document"
 require "omise/list"
 
 module Omise
   class DocumentList < List
     def retrieve(id, attributes = {})
+      if !defined?(Document)
+        require "omise/document"
+      end
+
       Document.new self.class.resource(location(id), attributes).get(attributes)
     end
 
     def upload(file)
+      if !defined?(Document)
+        require "omise/document"
+      end
+
       attributes = { file: file }
       Document.new self.class.resource(location, attributes).post(attributes)
     end

data/lib/omise/http_logger.rb

@@ -0,0 +1,59 @@
+module Omise
+  class HTTPLogger
+    LABEL = "[Omise]".freeze
+
+    def initialize(logger = nil)
+      @logger = logger
+    end
+
+    attr_reader :logger
+
+    def log_request(request)
+      info(format_request(request))
+    end
+
+    def log_response(response)
+      info(format_response(response))
+    end
+
+    private
+
+    def info(message)
+      return unless @logger
+
+      @logger.info(message)
+    end
+
+    def format_request(request)
+      StringIO.open do |s|
+        s.puts("#{LABEL} Request: #{request.method.to_s.upcase} #{request.url}")
+        s.puts(format_headers(request.processed_headers))
+        s.puts
+        s.puts(format_payload(request.args[:payload])) if request.args[:payload]
+
+        s.string
+      end
+    end
+
+    def format_response(response)
+      net_http = response.net_http_res
+
+      StringIO.open do |s|
+        s.puts("#{LABEL} Response: HTTP/#{net_http.http_version} #{net_http.code} #{net_http.message}")
+        s.puts(format_headers(net_http.each_capitalized))
+        s.puts
+        s.puts(response.body)
+
+        s.string
+      end
+    end
+
+    def format_headers(headers)
+      headers.map { |name, value| "#{name}: #{value}" }.join("\n")
+    end
+
+    def format_payload(payload)
+      payload.map { |key, value| "#{key}=#{value}" }.join("&")
+    end
+  end
+end

data/lib/omise/link.rb

@@ -1,5 +1,7 @@
 require "omise/object"
+require "omise/list"
 require "omise/charge_list"
+require "omise/search_scope"
 
 module Omise
   class Link < OmiseObject

data/lib/omise/object.rb

@@ -1,6 +1,5 @@
 require "omise/config"
 require "omise/attributes"
-require "omise/resource"
 
 module Omise
   class OmiseObject
@@ -43,7 +42,7 @@ module Omise
       end
 
       def resource_key
-        Omise.api_key
+        Omise.secret_api_key
       end
     end
 

data/lib/omise/recipient.rb

@@ -1,5 +1,5 @@
 require "omise/object"
-require "omise/bank_account"
+require "omise/list"
 require "omise/search_scope"
 
 module Omise
@@ -35,6 +35,10 @@ module Omise
     end
 
     def bank_account
+      if !defined?(BankAccount)
+        require "omise/bank_account"
+      end
+
       expand_attribute BankAccount, "bank_account"
     end
   end

data/lib/omise/refund.rb

@@ -1,6 +1,5 @@
 require "omise/object"
-require "omise/charge"
-require "omise/transaction"
+require "omise/search_scope"
 
 module Omise
   class Refund < OmiseObject
@@ -15,10 +14,18 @@ module Omise
     end
 
     def charge(options = {})
+      if !defined?(Charge)
+        require "omise/charge"
+      end
+
       expand_attribute Charge, "charge", options
     end
 
     def transaction(options = {})
+      if !defined?(Transaction)
+        require "omise/transaction"
+      end
+
       expand_attribute Transaction, "transaction", options
     end
   end

data/lib/omise/refund_list.rb

@@ -1,5 +1,4 @@
 require "omise/list"
-require "omise/refund"
 
 module Omise
   class RefundList < List

data/lib/omise/resource.rb

@@ -1,11 +1,8 @@
 require "uri"
-require "json"
 require "openssl"
 require "rest-client"
 
 require "omise/util"
-require "omise/config"
-require "omise/error"
 require "omise/version"
 
 module Omise
@@ -31,19 +28,31 @@ module Omise
         set_resource
       end
 
-      @resource.get { |r| Omise::Util.load_response(r) }
+      @resource.get do |response, request|
+        log(request, response)
+        Omise::Util.load_response(response)
+      end
     end
 
     def patch(attributes = {})
-      @resource.patch(attributes) { |r| Omise::Util.load_response(r) }
+      @resource.patch(attributes) do |response, request|
+        log(request, response)
+        Omise::Util.load_response(response)
+      end
     end
 
     def post(attributes = {})
-      @resource.post(attributes) { |r| Omise::Util.load_response(r) }
+      @resource.post(attributes) do |response, request|
+        log(request, response)
+        Omise::Util.load_response(response)
+      end
     end
 
     def delete
-      @resource.delete { |r| Omise::Util.load_response(r) }
+      @resource.delete do |response, request|
+        log(request, response)
+        Omise::Util.load_response(response)
+      end
     end
 
     private
@@ -57,6 +66,11 @@ module Omise
       })
     end
 
+    def log(request, response)
+      Omise.http_logger.log_request(request)
+      Omise.http_logger.log_response(response)
+    end
+
     def prepare_uri(url, path)
       URI.parse(url).tap do |uri|
         path  = URI.parse(path)

data/lib/omise/transfer.rb

@@ -1,7 +1,6 @@
 require "omise/object"
 require "omise/bank_account"
-require "omise/list"
-require "omise/recipient"
+require "omise/search_scope"
 
 module Omise
   class Transfer < OmiseObject
@@ -36,10 +35,18 @@ module Omise
     end
 
     def recipient(options = {})
+      if !defined?(Recipient)
+        require "omise/recipient"
+      end
+
       expand_attribute Recipient, "recipient", options
     end
 
     def bank_account
+      if !defined?(BankAccount)
+        require "omise/bank_account"
+      end
+
       expand_attribute BankAccount, "bank_account"
     end
   end

data/lib/omise/util.rb

@@ -1,7 +1,6 @@
 require "cgi"
 require "json"
 
-require "omise/object"
 require "omise/error"
 
 module Omise

data/lib/omise/vault.rb

@@ -1,5 +1,3 @@
-require "omise/config"
-
 module Omise
   module Vault
     private
@@ -9,7 +7,7 @@ module Omise
     end
 
     def resource_key
-      Omise.vault_key
+      Omise.public_api_key
     end
   end
 end

data/lib/omise/version.rb

@@ -1,3 +1,3 @@
 module Omise
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/lib/omise.rb

@@ -1,6 +1,6 @@
+require "omise/config"
 require "omise/all"
 require "omise/version"
 
 module Omise
-  LIB_PATH = File.expand_path("../", __FILE__)
 end

data/omise.gemspec

@@ -17,11 +17,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rest-client", "~> 1.8.0"
-  spec.add_dependency "json", "~> 1.8.1"
+  spec.add_dependency "rest-client", ">= 2.0"
+  spec.add_dependency "json", ">= 1.8"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "minitest", "~> 5.4.2"
+  spec.add_development_dependency "minitest", ">= 5.4"
 end

data/test/omise/test_charge.rb

@@ -12,6 +12,15 @@ class TestCharge < Omise::Test
     assert_equal "chrg_test_4yq7duw15p9hdrjp8oq", charge.id
   end
 
+  def test_that_we_can_create_a_charge_even_if_api_key_is_nil
+    without_keys do
+      charge = Omise::Charge.create(key: "skey_test_4yq6tct0lblmed2yp5t")
+
+      assert_instance_of Omise::Charge, charge
+      assert_equal "chrg_test_4yq7duw15p9hdrjp8oq", charge.id
+    end
+  end
+
   def test_that_we_can_retrieve_a_charge
     assert_instance_of Omise::Charge, @charge
     assert_equal "chrg_test_4yq7duw15p9hdrjp8oq", @charge.id

data/test/omise/test_config.rb

@@ -0,0 +1,24 @@
+require "support"
+
+class TestConfig < Omise::Test
+  def test_that_default_values_are_set
+    assert_equal "https://api.omise.co", Omise.api_url
+    assert_equal "https://vault.omise.co", Omise.vault_url
+  end
+
+  def test_that_default_http_logger_is_set
+    assert_instance_of Omise::HTTPLogger, Omise.http_logger
+    assert_nil Omise.http_logger.logger
+  end
+
+  def test_that_we_can_set_a_logger
+    logger = Logger.new(STDOUT)
+    Omise.logger = logger
+
+    assert_same logger, Omise.http_logger.logger
+  end
+
+  def teardown
+    Omise.logger = nil
+  end
+end

data/test/omise/test_http_logger.rb

@@ -0,0 +1,69 @@
+require "support"
+
+class TestHTTPLogger < Omise::Test
+  def test_we_can_initialize_a_logger_with_default_log
+    http_logger = Omise::HTTPLogger.new
+
+    assert_instance_of Omise::HTTPLogger, http_logger
+    assert_nil http_logger.logger
+  end
+
+  def test_we_can_initialize_a_logger_setting_a_log
+    logger = Logger.new(STDOUT)
+    http_logger = Omise::HTTPLogger.new(logger)
+
+    assert_instance_of Omise::HTTPLogger, http_logger
+    assert_same logger, http_logger.logger
+  end
+
+  def setup
+    @log_mock = MiniTest::Mock.new
+  end
+
+  def test_we_can_log_an_http_request
+    request = Struct.new(
+      :method,
+      :url,
+      :processed_headers,
+      :args
+    ).new(
+      :post,
+      "http://api.omise.co/path",
+      { "Header" => "value" },
+      { payload: { var1: "value1", var2: "value2" } },
+    )
+    expected_log_message = "[Omise] Request: POST http://api.omise.co/path\nHeader: value\n\nvar1=value1&var2=value2\n"
+    @log_mock.expect(:info, nil, [expected_log_message])
+
+    Omise::HTTPLogger.new(@log_mock).log_request(request)
+
+    assert @log_mock.verify
+  end
+
+  def test_we_can_log_an_http_response
+    net_http = Struct.new(
+      :http_version,
+      :code,
+      :message,
+      :each_capitalized
+    ).new(
+      "1.1",
+      200,
+      "OK",
+      [["Header", "value"]]
+    )
+    response = Struct.new(
+      :net_http_res,
+      :body
+    ).new(
+      net_http,
+      "Work my body over"
+    )
+    expected_log_message = "[Omise] Response: HTTP/1.1 200 OK\nHeader: value\n\nWork my body over\n"
+    @log_mock.expect(:info, nil, [expected_log_message])
+
+    Omise::HTTPLogger.new(@log_mock).log_response(response)
+
+    assert @log_mock.verify
+  end
+end

data/test/support.rb

@@ -9,9 +9,9 @@ module Omise
   class Test < Minitest::Test
     def before_setup
       Omise.test!
-      Omise.vault_key   = "pkey_test_4yq6tct0llin5nyyi5l"
-      Omise.api_key     = "skey_test_4yq6tct0lblmed2yp5t"
-      Omise.api_version = nil
+      Omise.api_version    = nil
+      Omise.public_api_key = "pkey_test_4yq6tct0llin5nyyi5l"
+      Omise.secret_api_key = "skey_test_4yq6tct0lblmed2yp5t"
     end
 
     def setup
@@ -24,5 +24,20 @@ module Omise
         instance_exec(&block)
       end
     end
+
+    private
+
+    def without_keys
+      original_vault_key = Omise.vault_key
+      original_api_key   = Omise.api_key
+
+      Omise.vault_key = nil
+      Omise.api_key   = nil
+
+      yield
+
+      Omise.vault_key = original_vault_key
+      Omise.api_key   = original_api_key
+    end
   end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: omise
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Robin Clart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-25 00:00:00.000000000 Z
+date: 2017-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.4.2
+        version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.4.2
+        version: '5.4'
 description: 
 email:
 - robin@omise.co
@@ -127,6 +127,7 @@ files:
 - lib/omise/document_list.rb
 - lib/omise/error.rb
 - lib/omise/event.rb
+- lib/omise/http_logger.rb
 - lib/omise/link.rb
 - lib/omise/list.rb
 - lib/omise/object.rb
@@ -209,10 +210,12 @@ files:
 - test/omise/test_balance.rb
 - test/omise/test_card.rb
 - test/omise/test_charge.rb
+- test/omise/test_config.rb
 - test/omise/test_customer.rb
 - test/omise/test_dispute.rb
 - test/omise/test_document.rb
 - test/omise/test_event.rb
+- test/omise/test_http_logger.rb
 - test/omise/test_link.rb
 - test/omise/test_list.rb
 - test/omise/test_recipient.rb
@@ -245,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Omise Ruby client
@@ -314,10 +317,12 @@ test_files:
 - test/omise/test_balance.rb
 - test/omise/test_card.rb
 - test/omise/test_charge.rb
+- test/omise/test_config.rb
 - test/omise/test_customer.rb
 - test/omise/test_dispute.rb
 - test/omise/test_document.rb
 - test/omise/test_event.rb
+- test/omise/test_http_logger.rb
 - test/omise/test_link.rb
 - test/omise/test_list.rb
 - test/omise/test_recipient.rb