webpay 2.4.1 → 3.0.0

data/lib/webpay/card.rb

@@ -1,13 +0,0 @@
-module WebPay
-
-  # Object for API response hash object with <code>hash['object'] = card</code>.
-  # Card is not accessible as an API endpoint
-  class Card < Entity
-
-    # Check equality with rhs
-    # @return [Boolean] true if rhs is the same object, or it is a Card with the same fingerprint value
-    def ==(other)
-      other.equals?(self) || (other.instance_of?(self.class) && other.fingerprint == self.fingerprint)
-    end
-  end
-end

data/lib/webpay/client.rb

@@ -1,81 +0,0 @@
-require 'faraday'
-require 'json'
-
-module WebPay
-
-  # API client wrapping of Faraday.
-  # Not intended to use directly.
-  class Client
-
-    # Initialize client
-    #
-    # @param api_key [String] User's secret API key
-    # @param api_base [String] the URL without trailing '/'.
-    # @param api_version [String] the path indicating API version. `/v1`.
-    #
-    # @example Client for the default endpoint
-    #     Client.new('test_secret_XXXX', 'https://api.webpay.jp', '/v1')
-    def initialize(api_key, api_base, api_version, api_proxy = nil, lang = :en)
-      ssl_options = {ca_file: WebPay.ssl_ca_file}
-      default_headers = {
-        'Authorization' => "Bearer #{api_key}",
-        'User-Agent' => "WebPay#{api_version} RubyBinding/#{WebPay::VERSION}",
-        'Accept-Language' => lang.to_s
-      }
-      @conn = Faraday.new(api_base, ssl: ssl_options, headers: default_headers, proxy: api_proxy) do |builder|
-        builder.request :url_encoded
-        builder.adapter Faraday.default_adapter
-      end
-      @api_version = api_version
-    end
-
-    # Convert faraday response to a hash by decoding JSON.
-    # This raises error if the response indicates error status.
-    #
-    # @api private
-    # @param response [Faraday::Response]
-    # @return [Hash] Raw object
-    # @raise [WebPay::WebPayError] For invalid requests (4xx) or internal server error (5xx)
-    def handle_response(response)
-      case response.status
-      when 200..299
-        begin
-          JSON.parse(response.body.force_encoding(infer_encoding(response)))
-        rescue JSON::ParserError => e
-          raise WebPay::APIConnectionError.new("Response JSON is broken. #{e.message}: #{response.body}", e)
-        end
-      else
-        raise WebPay::WebPayError.from_response(response.status, response.body)
-      end
-    end
-
-    Faraday::Connection::METHODS.each do |method|
-      define_method(method) do |url, *args|
-        begin
-          response = @conn.__send__(method, @api_version + url, *args)
-        rescue Faraday::Error::ClientError, URI::InvalidURIError => e
-          raise WebPay::APIConnectionError.faraday_error(e)
-        end
-        handle_response(response)
-      end
-    end
-
-    private
-
-    # Infer encoding from response
-    #
-    # @param response [Faraday::Response]
-    # @return [Encoding]
-    def infer_encoding(response)
-      unless (type = response.headers['content-type']) &&
-          (charset = type.split(';').find { |field| field.include?('charset=') })
-        return Encoding.default_external
-      end
-
-      encoding_string = charset.split('=', 2).last.strip
-      Encoding.find(encoding_string)
-    rescue
-      Encoding.default_external
-    end
-  end
-end

data/lib/webpay/deleted_entity.rb

@@ -1,8 +0,0 @@
-module WebPay
-  class DeletedEntity < Entity
-    # @return [Boolean] true
-    def deleted?
-      true
-    end
-  end
-end

data/lib/webpay/entity.rb

@@ -1,71 +0,0 @@
-module WebPay
-
-  # The base class for entity objects
-  # @abstract
-  class Entity
-    class << self
-      include Operations
-
-      # Convert hash API response into an entity object
-      # @param [Hash] hash Raw API response
-      # @return [Entity] An entity object corresponds to hash
-      def convert(hash)
-        converter = ResponseConverter.new
-        converter.convert(hash)
-      end
-    end
-
-    # Attributes of this object.
-    # <code>method_missing</code> and <code>#[]</code> are provided to access attributes
-    attr_reader :attributes
-
-    # Initialized by ResponseConverter
-    # @api private
-    def initialize(attributes)
-      @attributes = attributes
-    end
-
-    # @return [Boolean] true if rhs is the same object or has the same id
-    def ==(other)
-      other.equal?(self) || (other.instance_of?(self.class) && other.id == self.id)
-    end
-
-    # Access attribute.
-    # Using the attribute name as a method is recommended.
-    # @return [Object] The attribute's value
-    def [](key)
-      send(key)
-    end
-
-    # Return a hash similar to the response from API.
-    # @return [Hash] a hash similar to the response from API
-    def to_hash
-      Hash[@attributes.map { |k, v| [k, v.is_a?(Entity) ? v.to_hash : v] }]
-    end
-
-    alias_method :to_h, :to_hash
-
-    # Provide access to attributes
-    # @return [Object] The attribute's value
-    def method_missing(method_name, *args, &block)
-      key = method_name.to_s
-      if @attributes.has_key?(key)
-        @attributes[key]
-      else
-        super
-      end
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      @attributes.has_key?(method_name.to_s) || super
-    end
-
-    private
-    def update_attributes(attributes)
-      raise "unexpected object" if attributes['object'] != @attributes['object']
-      new_object = ResponseConverter.new.convert(attributes)
-      @attributes = new_object.attributes
-      self
-    end
-  end
-end

data/lib/webpay/entity_list.rb

@@ -1,25 +0,0 @@
-module WebPay
-
-  # Object for API response hash object with <code>hash['object'] = list</code>.
-  # This enumerates containing data.
-  class EntityList < Entity
-    include Enumerable
-
-    # @return [Boolean] true if rhs is the same object or id lists of containing data are the same
-    def ==(other)
-      other.equal?(self) ||
-        (other.instance_of?(self.class) && other.data.map(&:id) == self.data.map(&:id))
-    end
-
-    # Return the all entry count, not limited by <code>limit</code>.
-    # This overrides <code>Enumerable#count</code>.  Not necessarily equal to the data size.
-    def count
-      @attributes['count']
-    end
-
-    # Enumerate containing data.
-    def each(&block)
-      self.data.each(&block)
-    end
-  end
-end

data/lib/webpay/fee.rb

@@ -1,13 +0,0 @@
-module WebPay
-
-  # Object for API response hash object with <code>hash['object'] = fee</code>.
-  # Fee is not accessible as an API endpoint
-  class Fee < Entity
-
-    # Check equality with rhs
-    # @return [Boolean] true only if rhs is the same object
-    def ==(other)
-      self.equal?(other)
-    end
-  end
-end

data/lib/webpay/operations.rb

@@ -1,49 +0,0 @@
-module WebPay
-
-  # This module installs collection operations to entities.
-  # Some of <code>create</code>, <code>retrieve</code>, and <code>all</code> are defined as class methods.
-  module Operations
-
-    # Install selected operations
-    # @api private
-    def install_class_operations(*operations)
-      define_create if operations.include?(:create)
-      define_retrieve if operations.include?(:retrieve)
-      define_all if operations.include?(:all)
-    end
-
-    # Define <code>create</code> method
-    # @api private
-    def define_create
-      instance_eval do
-        def create(params = {})
-          convert(WebPay.client.post(path, params))
-        end
-      end
-    end
-
-    # Define <code>retrieve(id)</code> method
-    # @api private
-    def define_retrieve
-      instance_eval do
-        def retrieve(id)
-          id = id.to_s
-          if id.strip == ''
-            raise InvalidRequestError.invalid_id(id)
-          end
-          convert(WebPay.client.get([path, id].join('/')))
-        end
-      end
-    end
-
-    # Define <code>all</code> method
-    # @api private
-    def define_all
-      instance_eval do
-        def all(params = {})
-          convert(WebPay.client.get(path, params))
-        end
-      end
-    end
-  end
-end

data/lib/webpay/response_converter.rb

@@ -1,57 +0,0 @@
-module WebPay
-
-  # Converts raw Hash response to an entity
-  class ResponseConverter
-
-    # Converts raw Hash response to an entity.
-    # This recursively changes internal objects.
-    # @param [Hash] attributes Raw API response
-    # @return [Entity] Corresponding entity
-    def convert(attributes)
-      case attributes['object']
-      when 'card'
-        Card.new(attributes)
-      when 'fee'
-        Fee.new(attributes)
-      when 'charge'
-        if attributes['card']
-          attributes['card'] = convert(attributes['card'])
-        end
-        if attributes['fees']
-          attributes['fees'] = attributes['fees'].map { |fee| convert(fee) }
-        end
-        Charge.new(attributes)
-      when 'customer'
-        if attributes['active_card']
-          attributes['active_card'] = convert(attributes['active_card'])
-        end
-        if attributes['recursions']
-          attributes['recursions'] = attributes['recursions'].map { |recursion| convert(recursion) }
-        end
-        Customer.new(attributes)
-      when 'token'
-        if attributes['card']
-          attributes['card'] = convert(attributes['card'])
-        end
-        Token.new(attributes)
-      when 'event'
-        if attributes['data']
-          attributes['data']['object'] = convert(attributes['data']['object'])
-          attributes['data'] = Event::Data.new(attributes['data'])
-        end
-        Event.new(attributes)
-      when 'shop'
-        Shop.new(attributes)
-      when 'recursion'
-        Recursion.new(attributes)
-      when 'account'
-        Account.new(attributes)
-
-      when 'list'
-        attributes['data'] ||= []
-        attributes['data'].map! { |line| convert(line) }
-        EntityList.new(attributes)
-      end
-    end
-  end
-end

data/lib/webpay/version.rb

@@ -1,5 +0,0 @@
-module WebPay
-
-  # Version of WebPay gem
-  VERSION = "2.4.1"
-end

data/lib/webpay/webpay_error.rb

@@ -1,126 +0,0 @@
-require 'json'
-module WebPay
-
-  # Abstract error class for WebPay errors.
-  # All WebPay error classes inherit this.
-  # This error itself is not raised.
-  class WebPayError < StandardError
-    # @api private
-    # @return [WebPayError]
-    def self.from_response(status, body)
-      hash =
-        begin
-          JSON.load(body)
-        rescue JSON::ParserError => e
-          return WebPay::APIConnectionError.new("Response JSON is broken. #{e.message}: #{body}", e)
-        end
-      unless hash['error']
-        return APIConnectionError.new("Invalid response #{body}")
-      end
-      error_hash = hash['error']
-      case status
-      when 400, 404
-        InvalidRequestError.new(status, error_hash)
-      when 401
-        AuthenticationError.new(status, error_hash)
-      when 402
-        CardError.new(status, error_hash)
-      else
-        APIError.new(status, error_hash)
-      end
-    end
-
-    # @return [Integer, nil] HTTP status code
-    attr_reader :status
-
-    # @return [Hash, nil] Responded error object
-    attr_reader :error_response
-
-    def initialize(message, status = nil, error_response = nil)
-      @status, @error_response = status, error_response
-      super(message)
-    end
-  end
-
-  # This error is raised when API request fails.
-  class APIConnectionError < WebPayError
-    # @api private
-    # @return [APIConnectionError]
-    def self.faraday_error(e)
-      new("Connection with WebPay API server failed. #{e.message}", e)
-    end
-
-    # @return [Error] The original error raised in request
-    attr_reader :original_error
-
-    def initialize(message, original_error = nil)
-      @original_error = original_error
-      super(message)
-    end
-  end
-
-  # This error means WebPay service reported internal server error.
-  class APIError < WebPayError
-
-    # @return [String] 'api_error' or 'processing_error'
-    attr_reader :type
-
-    def initialize(status, error_response)
-      @type = error_response['type']
-      super(error_response['message'], status, error_response)
-    end
-  end
-
-  # Occurs when api_key is invalid.
-  # Check again that a correct api_key is set
-  class AuthenticationError < WebPayError
-    def initialize(status, error_response)
-      super(error_response['message'], status, error_response)
-    end
-  end
-
-  # Occurs when card information is invalid
-  class CardError < WebPayError
-
-    # @return [String] 'card_error'
-    attr_reader :type
-
-    # @return [String] Error code
-    attr_reader :code
-
-    # @return [String] The field where an error is detected
-    attr_reader :param
-
-    def initialize(status, error_response)
-      @type = error_response['type']
-      @code = error_response['code']
-      @param = error_response['param']
-      super(error_response['message'], status, error_response)
-    end
-  end
-
-  # Occurs when the specified entity is not found, or request parameters are
-  # invalid
-  class InvalidRequestError < WebPayError
-
-    # @return [String] 'invalid_request_error'
-    attr_reader :type
-
-    # @return [String] The field where an error is detected
-    attr_reader :param
-
-    def initialize(status, error_response)
-      @type = error_response['type']
-      @param = error_response['param']
-      super(error_response['message'], status, error_response)
-    end
-
-    # Internal
-    def self.invalid_id(id)
-      InvalidRequestError.new(nil, {
-          'type' => 'invalid_request_error',
-          'message' => "ID must not be empty",
-          'param' => 'id' })
-    end
-  end
-end

data/spec/resources/account/delete.txt

@@ -1,15 +0,0 @@
-HTTP/1.1 200 OK
-Content-Type: application/json; charset=utf-8
-X-Ua-Compatible: IE=Edge
-Etag: "ffc2622aa8286367b501554d9625bc7e"
-Cache-Control: max-age=0, private, must-revalidate
-X-Request-Id: b90a98ba6c730796bb4651b30eefcf3d
-X-Runtime: 0.030542
-Server: WEBrick/1.3.1 (Ruby/1.9.3/2013-02-22)
-Date: Wed, 11 Sep 2013 12:50:01 GMT
-Content-Length: 22
-Connection: Keep-Alive
-
-{
-  "deleted": true
-}

data/spec/resources/account/retrieve.txt

@@ -1,23 +0,0 @@
-HTTP/1.1 200 OK
-Content-Type: application/json; charset=utf-8
-X-Ua-Compatible: IE=Edge
-Etag: "bfda5f4ce8f4baff2dc95b81d3eeddc8"
-Cache-Control: max-age=0, private, must-revalidate
-X-Request-Id: ac424d922fefdd1625e41bda0e13f4b8
-X-Runtime: 0.057802
-Server: WEBrick/1.3.1 (Ruby/1.9.3/2013-02-22)
-Date: Wed, 11 Sep 2013 12:48:50 GMT
-Content-Length: 234
-Connection: Keep-Alive
-
-{
-  "object": "account",
-  "id": "acct_2Cmdexb7J2r78rz",
-  "email": "test-me@example.com",
-  "statement_descriptor": null,
-  "details_submitted": false,
-  "charge_enabled": false,
-  "currencies_supported": [
-    "jpy"
-  ]
-}

data/spec/resources/charges/all.txt

@@ -1,139 +0,0 @@
-HTTP/1.1 200 OK 
-Content-Type: application/json; charset=utf-8
-X-Ua-Compatible: IE=Edge
-Etag: "d62affbd4db0c10ce2244cc7d5a05249"
-Cache-Control: max-age=0, private, must-revalidate
-X-Request-Id: c53aade07e31b8c4cc03c18bfe5ee086
-X-Runtime: 0.013481
-Server: WEBrick/1.3.1 (Ruby/1.9.3/2013-02-22)
-Date: Mon, 14 Apr 2014 02:43:46 GMT
-Content-Length: 3067
-Connection: Keep-Alive
-
-{
-  "object": "list",
-  "url": "/v1/charges",
-  "count": 4,
-  "data": [
-    {
-      "id": "ch_511apkasx749bfE",
-      "object": "charge",
-      "livemode": false,
-      "currency": "jpy",
-      "description": "Test Charge",
-      "amount": 1000,
-      "amount_refunded": 0,
-      "customer": "cus_5119ShaAgbLyfwS",
-      "created": 1397443228,
-      "paid": false,
-      "refunded": false,
-      "failure_message": null,
-      "card": {
-        "object": "card",
-        "exp_year": 2016,
-        "exp_month": 9,
-        "fingerprint": "215b5b2fe460809b8bb90bae6eeac0e0e0987bd7",
-        "name": "KEI KUBO",
-        "country": "JP",
-        "type": "Visa",
-        "cvc_check": "pass",
-        "last4": "4242"
-      },
-      "captured": false,
-      "expire_time": 1398048028,
-      "fees": [
-
-      ]
-    },
-    {
-      "id": "ch_5119xE4mH4zA9p9",
-      "object": "charge",
-      "livemode": false,
-      "currency": "jpy",
-      "description": "Test Charge",
-      "amount": 1000,
-      "amount_refunded": 0,
-      "customer": "cus_5119ShaAgbLyfwS",
-      "created": 1397443215,
-      "paid": true,
-      "refunded": false,
-      "failure_message": null,
-      "card": {
-        "object": "card",
-        "exp_year": 2016,
-        "exp_month": 9,
-        "fingerprint": "215b5b2fe460809b8bb90bae6eeac0e0e0987bd7",
-        "name": "KEI KUBO",
-        "country": "JP",
-        "type": "Visa",
-        "cvc_check": "pass",
-        "last4": "4242"
-      },
-      "captured": true,
-      "expire_time": null,
-      "fees": [
-        {
-          "object": "fee",
-          "transaction_type": "payment",
-          "transaction_fee": 0,
-          "rate": 35.0,
-          "amount": 350,
-          "created": 1397443216
-        }
-      ]
-    },
-    {
-      "id": "ch_5112dr0Mu5Kyd2I",
-      "object": "charge",
-      "livemode": false,
-      "currency": "jpy",
-      "description": "Test Charge",
-      "amount": 1000,
-      "amount_refunded": 400,
-      "customer": null,
-      "created": 1397442849,
-      "paid": true,
-      "refunded": false,
-      "failure_message": null,
-      "card": {
-        "object": "card",
-        "exp_year": 2015,
-        "exp_month": 12,
-        "fingerprint": "215b5b2fe460809b8bb90bae6eeac0e0e0987bd7",
-        "name": "YUUKO SHIONJI",
-        "country": "JP",
-        "type": "Visa",
-        "cvc_check": "pass",
-        "last4": "4242"
-      },
-      "captured": true,
-      "expire_time": null,
-      "fees": [
-        {
-          "object": "fee",
-          "transaction_type": "payment",
-          "transaction_fee": 0,
-          "rate": 35.0,
-          "amount": 350,
-          "created": 1397442849
-        },
-        {
-          "object": "fee",
-          "transaction_type": "refund",
-          "transaction_fee": 0,
-          "rate": 35.0,
-          "amount": -350,
-          "created": 1397443154
-        },
-        {
-          "object": "fee",
-          "transaction_type": "payment",
-          "transaction_fee": 0,
-          "rate": 35.0,
-          "amount": 210,
-          "created": 1397443154
-        }
-      ]
-    }
-  ]
-}

data/spec/resources/charges/capture.txt

@@ -1,49 +0,0 @@
-HTTP/1.1 200 OK 
-Content-Type: application/json; charset=utf-8
-X-Ua-Compatible: IE=Edge
-Etag: "55751ab0623ce3649f648ce9161a340e"
-Cache-Control: max-age=0, private, must-revalidate
-X-Request-Id: e57b763f56b9212d2aac3d5204303b59
-X-Runtime: 0.471463
-Server: WEBrick/1.3.1 (Ruby/1.9.3/2013-02-22)
-Date: Mon, 14 Apr 2014 02:58:16 GMT
-Content-Length: 785
-Connection: Keep-Alive
-
-{
-  "id": "ch_5113hA4L51yj8TF",
-  "object": "charge",
-  "livemode": false,
-  "currency": "jpy",
-  "description": "Test Charge",
-  "amount": 1000,
-  "amount_refunded": 0,
-  "customer": "cus_5119ShaAgbLyfwS",
-  "created": 1397444145,
-  "paid": true,
-  "refunded": false,
-  "failure_message": null,
-  "card": {
-    "object": "card",
-    "exp_year": 2016,
-    "exp_month": 9,
-    "fingerprint": "215b5b2fe460809b8bb90bae6eeac0e0e0987bd7",
-    "name": "KEI KUBO",
-    "country": "JP",
-    "type": "Visa",
-    "cvc_check": "pass",
-    "last4": "4242"
-  },
-  "captured": true,
-  "expire_time": 1398048945,
-  "fees": [
-    {
-      "object": "fee",
-      "transaction_type": "payment",
-      "transaction_fee": 0,
-      "rate": 3.25,
-      "amount": 33,
-      "created": 1397444296
-    }
-  ]
-}