jamm 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f327c3134101945f2fae416640e630efb160d4b1d68679d925689a73023fbabd
+  data.tar.gz: 3044598aaa52335f986638a8989dcae84ac7805f8676ee67e94f70896b391405
+SHA512:
+  metadata.gz: '08c55977ae46c049e48f7933ed2926d511562f96f4a3875f61ae9790611a392efe6fc075916675ff6b69eb2409e295e8c302a02a84cc058eb0b09231b176354d'
+  data.tar.gz: a74807913f38478fba27cbb5df6914089253d34223091a5638289aa398dc9b5cc8de0411ea5247f19cbc026af02981b437e23b1a9b181d4a5ad357dfda1cb43c

data/.github/workflows/build.yml

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,24 @@
+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/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+*.lock
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rubocop.yml

@@ -0,0 +1,53 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Security/MarshalLoad:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+AllCops:
+  SuggestExtensions: false
+  NewCops: disable

data/CONTRIBUTORS

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

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rest-client', '~> 2.0'
+
+group :development, :test do
+  gem 'mocha'
+  gem 'rake'
+  gem 'rubocop'
+  gem 'test-unit'
+  gem 'webmock'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jamm
+
+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,86 @@
+[![MIT License][license-shield]][license-url]
+
+<br />
+<div align="center">
+  <a href="https://github.com/jamm-pay/Jamm-SDK-Ruby">
+    <img src="images/jamm_logo.png" alt="logo" width="120" height="120">
+  </a>
+  <h3 align="center">Jamm SDK - Ruby</h3>
+  <p align="center">
+    The official Ruby SDK for Jamm's payment API! We strongly recommend using the SDK for backend integration in order to simplify and streamline your development process!
+    <br />
+    <a href="https://github.com/jamm-pay/Jamm-SDK-Ruby"><strong>Home »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/jamm-pay/Jamm-SDK-Ruby/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/jamm-pay/Jamm-SDK-Ruby/issues">Request Feature</a>
+  </p>
+</div>
+
+## How to Use
+```ruby
+require 'jamm'
+Jamm.client_id = '<your client id>'
+Jamm.client_secret = '<your client id>'
+Jamm.open_timeout = 30 # optionally
+Jamm.read_timeout = 90 # optionally
+# ex, create a deduction contract token
+deduction_token = Jamm::Payment.create(
+  initial_charge: {
+    description: 'Jamm',
+    initial_amount: 10_000,
+    currency: 'JPY'
+  },
+  redirect: {
+    success_url: 'http://www.example.com/success',
+    failure_url: 'http://www.example.com/fail',
+    info_url: 'http://www.example.com/customer_service',
+    expired_at: "2023-11-07T15:30:00.000+09:00"
+  },
+  metadata: {
+    key1: 'value1',
+    key2: 'value2'
+  },
+  customers: {
+    name: "Taro Taro",
+    katakanaFirstName: "タロ",
+    katakanaLastName: "タロ",
+    gender: "MALE",
+    postNum: "112-0001",
+    address: "東京都渋谷区１−１−１"
+    email: "test@jamm-pay.jp",
+    phone: "010-1234-5678"
+    birthdate: "2000-01-01",
+  },
+  options: {
+    force_kyc: true
+  }
+)
+```
+
+## Installation
+```sh
+gem install jamm
+```
+If you want to build the gem from source:
+```sh
+gem build jamm.gemspec
+```
+
+## Development
+Test cases can be run with: `bundle exec rake`
+
+### Requirements
+* Ruby 2.7.0 or above.
+* rest-client
+
+### Built With
+
+[![Ruby][Ruby.com]][Ruby-url]
+
+[license-shield]: https://img.shields.io/badge/license-MIT-blue?style=for-the-badge
+[issues-url]: https://github.com/jamm-pay/Jamm-SDK-Ruby/issues
+[license-url]: https://github.com/jamm-pay/Jamm-SDK-Ruby/blob/main/LICENSE
+[Ruby.com]: https://img.shields.io/badge/ruby-820C02?style=for-the-badge&logo=ruby&logoColor=white
+[Ruby-url]: https://ruby-lang.org/en

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'bundler/gem_tasks'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]
+
+Rake::TestTask.new do |t|
+  t.pattern = './test/**/*_test.rb'
+end

data/jamm.gemspec

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'jamm/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'jamm'
+  s.version     = Jamm::VERSION
+  s.required_ruby_version = '>= 2.7.0'
+  s.summary     = 'Ruby SDK for the Jamm API'
+  s.description = 'Jamm help you make payment without credit cards'
+  s.authors     = ['Jamm']
+  s.email       = 'support@jamm-pay.jp'
+  s.homepage    = ''
+  s.license     = 'MIT'
+
+  s.add_dependency('rest-client', '~> 2.0')
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.metadata = {
+    'source_code_uri' => 'https://github.com/jamm-pay/Jamm-SDK-Ruby'
+  }
+end

data/lib/jamm/api_operations/create.rb

@@ -0,0 +1,16 @@
+# 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

@@ -0,0 +1,16 @@
+# 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

@@ -0,0 +1,16 @@
+# 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

@@ -0,0 +1,16 @@
+# 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

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

data/lib/jamm/charge.rb

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

data/lib/jamm/errors.rb

@@ -0,0 +1,36 @@
+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)
+      @message = message
+      @http_status = http_status
+      @http_headers = http_headers
+      @http_body = http_body
+      @json_body = json_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? '' : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+
+  # 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