jamm 0.0.1 → 1.0.1

data/lib/jamm/errors.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Jamm
   class JammError < StandardError
     attr_reader :message, :http_body, :http_headers, :http_status, :json_body
 
     def initialize(message = nil, http_status: nil, http_headers: nil, http_body: nil, json_body: nil)
+      super(message)
+
       @message = message
       @http_status = http_status
       @http_headers = http_headers
@@ -19,18 +23,4 @@ module Jamm
   # OAuthError is raised when a request to AWS cognito failed
   class OAuthError < JammError
   end
-
-  # ApiConnectionError is raised when a request to Jamm api failed
-  class ApiConnectionError < JammError
-  end
-
-  # ApiError is raised when Jamm api failed with an unexpected reason
-  class ApiError < JammError
-  end
-
-  class InvalidRequestError < JammError
-  end
-
-  class AuthenticationError < JammError
-  end
 end

data/lib/jamm/oauth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rest-client'
 require 'json'
 require 'base64'
@@ -5,7 +7,7 @@ require 'jamm/errors'
 
 module Jamm
   module OAuth
-    def self.oauth_token
+    def self.token
       client_id = Jamm.client_id
       client_secret = Jamm.client_secret
       if client_id.nil? || client_secret.nil?

data/lib/jamm/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jamm
-  VERSION = '0.0.1'
+  VERSION = '1.0.1'
 end

data/lib/jamm.rb

@@ -1,146 +1,33 @@
-# FIXME: remove this line once manual testing completed
-$LOAD_PATH.unshift(File.dirname(__FILE__))
+# frozen_string_literal: true
+
 require 'rest-client'
 require 'openssl'
 require 'json'
 
-require 'jamm/api_operations/create'
-require 'jamm/api_operations/get'
-require 'jamm/api_operations/list'
-require 'jamm/api_operations/update'
-require 'jamm/version'
-require 'jamm/oauth'
-require 'jamm/request'
-require 'jamm/api_resource'
-require 'jamm/token'
-require 'jamm/payment'
-require 'jamm/charge'
-require 'jamm/util'
-require 'jamm/jamm_object'
+require 'jamm/api'
 require 'jamm/errors'
-require 'jamm/time_util'
+require 'jamm/oauth'
+require 'jamm/version'
 
+# Jamm Ruby SDK
 module Jamm
-  @api_base = 'http://api.jamm-pay.jp/api/v0'
-  @oauth_base = 'https://jamm-merchant-sandbox.auth.ap-northeast-1.amazoncognito.com'
+  # Configurable attributes.
+  @api_base = nil
+  @oauth_base = nil
   @open_timeout = 30
   @read_timeout = 90
   @max_retry = 0
-  @retry_initial_delay = 0.1
-  @retry_max_delay = 32
+
+  # Include OpenAPI generated module into root Jamm namespace.
+  # The OpenAPI sub-modules and methods can be accessed via Jamm::{foo}
+  include Api
 
   class << self
-    attr_accessor :client_id, :client_secret, :api_base, :oauth_base, :api_version, :connect_base,
+    attr_accessor :api, :client_id, :client_secret, :api_base, :oauth_base, :api_version, :connect_base,
                   :open_timeout, :read_timeout, :max_retry, :retry_initial_delay, :retry_max_delay
   end
 
-  def self.request_jamm_api(method, path, params = {}, headers = {})
-    access_token = OAuth.oauth_token
-    api_base_url = @api_base
-    open_timeout = @open_timeout
-    read_timeout = @read_timeout
-    max_retry = @max_retry
-    retry_initial_delay = @retry_initial_delay
-    retry_max_delay = @retry_max_delay
-
-    headers = {
-      authorization: "Bearer #{access_token}",
-      content_type: 'application/json',
-      X_JAMM_SDK_VERSION: "Ruby_#{VERSION}"
-    }.update(headers)
-    error_on_invalid_params(params)
-
-    url = api_url(path, api_base_url)
-
-    case method.to_s.downcase.to_sym
-    when :get, :head, :delete
-      # Make params into GET parameters
-      url + "#{URI.parse(url).query ? '&' : '?'}#{uri_encode(params)}" if params&.any?
-      payload = nil
-    else
-      payload = params.to_json
-    end
-
-    retry_count = 1
-
-    begin
-      response = execute_request(method: method, url: url, payload: payload, headers: headers,
-                                 read_timeout: read_timeout, open_timeout: open_timeout)
-    rescue SocketError
-      raise ApiConnectionError,
-            'An unexpected error happens while communicating to OAuth server. Check your network setting'
-    rescue RestClient::RequestTimeout
-      raise ApiConnectionError, "Timed out over #{read_timeout} sec."
-    rescue RestClient::ExceptionWithResponse => e
-      if (e.http_code == 429) && (retry_count <= max_retry)
-        sleep get_retry_delay(retry_count, retry_initial_delay, retry_max_delay)
-        retry_count += 1
-        retry
-      end
-
-      handle_api_error(e.http_code, e.http_body)
-    rescue RestClient::Exception => e
-      raise ApiError, "An unexpected error happens while communicating to Jamm server. #{e}"
-    end
-
-    parse(response)
-  end
-
-  def self.handle_api_error(http_code, http_body)
-    begin
-      error_obj = JSON.parse(http_body)
-      error_obj = Util.symbolize_names(error_obj)
-      error = error_obj[:error] or raise(ApiError) # escape from parsing
-    rescue JSON::ParserError, ApiError => e
-      raise ApiError.new "An unexpected error happens while parsing the error response. #{e}", http_status: http_code,
-                                                                                               http_body: http_body
-    end
-
-    case http_code
-    when 400, 404
-      raise InvalidRequestError.new error, http_status: http_code, http_body: http_body, json_body: error_obj
-    when 401
-      raise AuthenticationError.new error, http_status: http_code, http_body: http_body, json_body: error_obj
-    else
-      raise ApiError.new error, http_status: http_code, http_body: http_body, json_body: error_obj
-    end
-  end
-
-  def self.parse(response)
-    begin
-      response = JSON.parse(response.body)
-    rescue JSON::ParserError
-      raise ApiError.new "Invalid response object from API: #{response.inspect}. HTTP response code: #{response.code})",
-                         http_status: response.code, http_body: response.body
-    end
-
-    converted_response = Util.symbolize_names(response)
-    Util.convert_to_jamm_object(converted_response)
-  end
-
   def self.execute_request(option)
     RestClient::Request.execute(option)
   end
-
-  def self.get_retry_delay(retry_count, retry_initial_delay, retry_max_delay)
-    # Exponential backoff
-    [retry_max_delay, retry_initial_delay * 2**retry_count].min
-  end
-
-  def self.uri_encode(params)
-    Util.flatten_params(params)
-        .map { |k, v| "#{k}=#{Util.url_encode(v)}" }.join('&')
-  end
-
-  def self.api_url(url, api_base_url)
-    api_base_url + url
-  end
-
-  def self.error_on_invalid_params(params)
-    return if params.nil? || params.is_a?(Hash)
-
-    raise ArgumentError,
-          'request params should be either a Hash or nil ' \
-          "(was a #{params.class})"
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jamm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Jamm
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-21 00:00:00.000000000 Z
+date: 2024-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,52 +24,80 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 description: Jamm help you make payment without credit cards
 email: support@jamm-pay.jp
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/build.yml"
-- ".github/workflows/ruby-publish.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- CONTRIBUTORS
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- images/jamm_logo.png
 - jamm.gemspec
 - lib/jamm.rb
-- lib/jamm/api_operations/create.rb
-- lib/jamm/api_operations/get.rb
-- lib/jamm/api_operations/list.rb
-- lib/jamm/api_operations/update.rb
-- lib/jamm/api_resource.rb
-- lib/jamm/charge.rb
+- lib/jamm/api.rb
+- lib/jamm/api/api/customer_api.rb
+- lib/jamm/api/api/healthcheck_api.rb
+- lib/jamm/api/api/payment_api.rb
+- lib/jamm/api/api_client.rb
+- lib/jamm/api/api_error.rb
+- lib/jamm/api/configuration.rb
+- lib/jamm/api/models/customer_service_update_customer_body.rb
+- lib/jamm/api/models/protobuf_any.rb
+- lib/jamm/api/models/rpc_status.rb
+- lib/jamm/api/models/v1_buyer.rb
+- lib/jamm/api/models/v1_charge.rb
+- lib/jamm/api/models/v1_contract.rb
+- lib/jamm/api/models/v1_create_contract_with_charge_request.rb
+- lib/jamm/api/models/v1_create_contract_with_charge_response.rb
+- lib/jamm/api/models/v1_create_contract_without_charge_request.rb
+- lib/jamm/api/models/v1_create_contract_without_charge_response.rb
+- lib/jamm/api/models/v1_create_customer_request.rb
+- lib/jamm/api/models/v1_create_customer_response.rb
+- lib/jamm/api/models/v1_customer.rb
+- lib/jamm/api/models/v1_delete_customer_response.rb
+- lib/jamm/api/models/v1_get_customer_response.rb
+- lib/jamm/api/models/v1_initial_charge.rb
+- lib/jamm/api/models/v1_merchant.rb
+- lib/jamm/api/models/v1_merchant_customer.rb
+- lib/jamm/api/models/v1_payment_link.rb
+- lib/jamm/api/models/v1_ping_response.rb
+- lib/jamm/api/models/v1_update_customer_response.rb
+- lib/jamm/api/models/v1_url.rb
+- lib/jamm/api/version.rb
 - lib/jamm/errors.rb
-- lib/jamm/jamm_object.rb
 - lib/jamm/oauth.rb
-- lib/jamm/payment.rb
-- lib/jamm/request.rb
-- lib/jamm/time_util.rb
-- lib/jamm/token.rb
-- lib/jamm/util.rb
 - lib/jamm/version.rb
-- test/jamm/charge_test.rb
-- test/jamm/oauth_test.rb
-- test/jamm/payment_test.rb
-- test/jamm/time_util_test.rb
-- test/jamm/token_test.rb
-- test/test_data.rb
-- test/test_helper.rb
-homepage: ''
+homepage: https://jamm-pay.jp
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/jamm-pay/Jamm-SDK-Ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,15 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Ruby SDK for the Jamm API
-test_files:
-- test/jamm/charge_test.rb
-- test/jamm/oauth_test.rb
-- test/jamm/payment_test.rb
-- test/jamm/time_util_test.rb
-- test/jamm/token_test.rb
-- test/test_data.rb
-- test/test_helper.rb
+test_files: []

data/.github/workflows/build.yml

@@ -1,23 +0,0 @@
-name: Multibranch Ruby CI Flow
-
-on:
-  pull_request:
-    branches:
-      - main
-  push:
-    branches:
-      - main
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Ruby setup
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.2.2"
-      - name: Install dependencies
-        run: bundle install
-      - name: Run Test
-        run: bundle exec rake

data/.github/workflows/ruby-publish.yml

@@ -1,24 +0,0 @@
-name: Publish Ruby Package
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  deploy:
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.2'
-          bundler-cache: true
-      - name: Build and publish
-        env:
-          GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
-        run: |
-          bundle exec rake build
-          bundle exec gem push pkg/jamm-*.gem

data/CONTRIBUTORS

@@ -1 +0,0 @@
-Tomu Hirata tomu.hirata@gmail.com

data/lib/jamm/api_operations/create.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Jamm
-  module APIOperations
-    module Create
-      def create(params = {}, headers = {})
-        request_jamm_api(
-          method: :post,
-          path: resource_url,
-          params: params,
-          headers: headers
-        )
-      end
-    end
-  end
-end

data/lib/jamm/api_operations/get.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Jamm
-  module APIOperations
-    module Get
-      def get(id, params = {}, headers = {})
-        request_jamm_api(
-          method: :get,
-          path: "#{resource_url}/#{id}",
-          params: params,
-          headers: headers
-        )
-      end
-    end
-  end
-end

data/lib/jamm/api_operations/list.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Jamm
-  module APIOperations
-    module List
-      def list(params = {}, headers = {})
-        request_jamm_api(
-          method: :get,
-          path: resource_url,
-          params: params,
-          headers: headers
-        )
-      end
-    end
-  end
-end

data/lib/jamm/api_operations/update.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Jamm
-  module APIOperations
-    module Update
-      def update(id, params = {}, headers = {})
-        request_jamm_api(
-          method: :patch,
-          path: "#{resource_url}/#{id}",
-          params: params,
-          headers: headers
-        )
-      end
-    end
-  end
-end

data/lib/jamm/api_resource.rb

@@ -1,5 +0,0 @@
-module Jamm
-  class APIResource
-    include Jamm::Request
-  end
-end

data/lib/jamm/charge.rb

@@ -1,10 +0,0 @@
-module Jamm
-  class Charge < APIResource
-    extend Jamm::APIOperations::List
-    extend Jamm::APIOperations::Get
-
-    def self.resource_url
-      '/payments/charges'
-    end
-  end
-end