elements-pay 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b47abd86699fc6853689e4cd3063d67d639956fa0d7c5975cd18710adc748b0
+  data.tar.gz: 881405689ed69b828eec05919293cd374e381ec6ec80e0f914e268e31c221656
+SHA512:
+  metadata.gz: 717b8a25084bf9ad7aa2080fad21d34b88c07798575feb8ef73fb1d71e71ae010c536e7caa138863b6ce2eb676d172b93d0f20dc9d2b6f4d02cc67ee786a0c6d
+  data.tar.gz: 7b0e83fa3ddd3a9ed5cb8e64ee2df5e3df8c5d0eefe4250fcd64f410919442064cdbab42fd257a81d70c84ffc2c9327329dd0c88a1d6244e5b345cc1fa3d7920

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+elements-ruby-sdk

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.2

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'webmock'
+
+  gem 'byebug'
+  gem 'pry'
+  gem 'pry-byebug'
+
+  gem 'rubocop'
+end

data/README.md

@@ -0,0 +1,123 @@
+# Elements Ruby SDK
+
+Ruby bindings for the Elements API.
+
+## Installation 
+
+You may install the gem from Github Packages.
+
+First, you must authenticate yourself to Github Packages by creating a personal access token.
+You may do that in Github Settings > Developer settings > Personal access tokens. Please follow the instructions [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry#authenticating-to-github-packages).
+
+Then add the following to your Gemfile.
+
+```ruby
+source 'https://rubygems.pkg.github.com/elementspay' do
+  gem 'elements-pay', '>= 0.0.3'
+end
+```
+
+Build the gem from source:
+
+```bash
+$ gem build elements-pay.gemspec
+```
+
+## Configuration
+
+This library requires you to configure the API key:
+
+```ruby
+require "elements"
+
+Elements.configure do |c|
+  # You must set a valid api key
+  c.api_key = "my_api_key"
+  # Optionally, you can configure logging for request & response
+  c.logger = Logger.new($stdout)
+end
+```
+
+If you want to connect to the sandbox instead of production, you may configure the `api_base` to use the sandbox url:
+
+```ruby
+require "elements"
+
+Elements.configure do |c|
+  c.api_base = Elements::ElementsConfiguration::SANDBOX_URL
+end
+```
+
+## Usage
+
+```ruby
+require "elements"
+
+# To create an authorized charge 
+authorized_charge = Elements::Charge.create({
+  amount: 30000,
+  currency: "USD",
+  payment_method_id: "PM-XXXXXX" 
+})
+
+# Access model attributes like object fields
+
+authorized_charge.amount # 30000
+authorized_charge.currency # "USD"
+authorized_charge.captured? # false
+
+# To capture the charge
+captured_charge = Elements::Charge.capture(authorized_charge.id, 
+                                           { amount: 30000 })
+
+# To obtain a client token
+client_token = Elements::ClientToken.create({ external_customer_id: "foo" })
+
+# To retrieve payment method
+payment_method = Elements::PaymentMethod.retrieve({
+  payment_method_id: "PM-XXXXXX",
+  external_customer_id: "foo" 
+})
+```
+
+Please refer to our REST API docs for detailed API usage information.
+
+## Contribute
+
+Begin by cloning the repository on GitHub.
+
+```bash
+$ git clone git@github.com:elementspay/elements-ruby-sdk.git
+$ cd elements-ruby-sdk
+```
+
+You may then create your changes and issue pull requests.
+
+### Test your changes
+
+It is encouraged to test your changes using RSpec and mocks, but if you want to perform some adhoc testing,
+you may do so with a REPL like IRB. You may also run `./bin/elements-console` to launch the IRB session,
+this executable also includes Elements lib as a dependency for you automatically.
+
+By default, the SDK connects to the production Elements API. You may test your changes with a local or a sandbox environment, by configuring the proper
+`api_base` and `api_key`:
+
+```ruby
+require "elements"
+
+Elements.configure do |c|
+  c.api_base = "http://localhost:3000"
+  c.api_key = "my local api key"
+end
+```
+
+## Release
+
+First, bump the version number in `lib/elements/version.rb`, following the format of `major.minor.patch`
+
+Then create a pull request and have the version bump merged into master.
+
+After the master has been updated, check out a new tag according to the new version, say the new version is 1.6.7, then 
+you should create a new tag called `v1.6.7` and push that to remote.
+
+Once the tag has been pushed, Github action will launch the `.github/workflows/publish.yml`, and you should watch for progress in https://github.com/elementspay/elements-ruby-sdk/actions.

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+task default: %i[spec lint]
+
+begin
+  require 'rubocop/rake_task'
+
+  RuboCop::RakeTask.new(:lint) do |t|
+    t.fail_on_error = true
+  end
+rescue LoadError
+  # no rubocop available
+end
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.fail_on_error = true
+  end
+rescue LoadError
+  # no rspec available
+end

data/bin/elements-console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib/', __dir__)
+
+require 'irb'
+require 'irb/completion'
+require 'logger'
+require 'elements'
+
+Elements.configure do |c|
+  c.logger = Logger.new($stdout)
+end
+
+IRB.conf[:PROMPT_MODE] = :SIMPLE
+IRB.conf[:AUTO_INDENT] = true
+IRB.start

data/elements-pay.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), 'lib'))
+
+require 'elements/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'elements-pay'
+  s.version     = Elements::VERSION
+  s.summary     = 'The Elements Ruby SDK'
+  s.description = 'Ruby bindings for the Elements API'
+  s.author      = 'Elements'
+  s.email       = 'help@elements.io'
+  s.homepage    = 'https://elements.io'
+  s.license     = 'MIT'
+  s.metadata    = {
+    'github_repo' => 'git@github.com:elementspay/elements-ruby-sdk.git',
+    'bug_tracker_uri' => 'https://github.com/elementspay/elements-ruby-sdk/issues',
+    'source_code_uri' => 'https://github.com/elementspay/elements-ruby-sdk'
+  }
+
+  ignored = Regexp.union(
+    /\A\.git/,
+    /\A\.rubocop/,
+    /\A\.git/,
+    /\Aspec/
+  )
+
+  s.files = `git ls-files`.split("\n").reject { |f| ignored.match(f) }
+  s.require_paths = ['lib']
+  s.add_dependency 'addressable', '~> 2.5'
+  s.add_dependency 'rest-client', '~> 2.0', '>= 2.0.1'
+end