coins_paid_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76dfc07ca328248272a643ae517e9f4e3adfc8d4199df23c4e18aea9f90ee484
+  data.tar.gz: 522e768d858bc97704304a6021b42e06c5905cbebd151556de6d326a6fc5f62b
+SHA512:
+  metadata.gz: 25c3a98da0c552ac54e791d4df5cf939ffdb47be6a6bf17dc1de240e03769c69dc2b1edfaaf492e52c53eec3b2ee20a105bb17bc04a6e2af410adb09dbbdbd42
+  data.tar.gz: e06207597934bcb1279527225c76ac08ffb0273cba8ad36d2db96a9a90e3fa3ac4e899b5c1a01f220ff3799ee43ee28ba00f6887a38634b33bd8905d434b01bb

data/.circleci/config.yml

@@ -0,0 +1,108 @@
+version: 2.0
+defaults: &defaults
+  docker:
+    - image: circleci/ruby:2.5-stretch-node
+  working_directory: ~/coins_paid
+
+jobs:
+  checkout_code:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: mkdir log
+      - save_cache:
+          key: v1-repo-{{ .Environment.CIRCLE_SHA1 }}
+          paths:
+            - ~/coins_paid
+
+  download_cc_reporter:
+    <<: *defaults
+    steps:
+      - run:
+          name:  Download cc-test-reporter
+          command: |
+            mkdir -p cc/
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc/cc-test-reporter
+            chmod +x ./cc/cc-test-reporter
+      - persist_to_workspace:
+          root: ~/coins_paid
+          paths:
+            - cc/cc-test-reporter
+
+  run_bundler:
+    <<: *defaults
+    steps:
+      - restore_cache:
+          key: v1-repo-{{ .Environment.CIRCLE_SHA1 }}
+      - restore_cache:
+          key: v1-bundle-{{ checksum "Gemfile" }}
+      - run: echo "export rvm_ignore_gemsets_flag=1" >> ~/.rvmrc
+      - run: sudo apt-get update && sudo apt-get install -y libsodium-dev
+      - run: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3 
+      - save_cache:
+          key: v1-bundle-{{ checksum "Gemfile" }}
+          paths:
+            - ~/coins_paid/vendor/bundle
+
+  run_rspec_tests:
+    <<: *defaults
+    docker:
+      - image: circleci/ruby:2.5-stretch-node
+    environment:
+      RACK_ENV: "test"
+      CIRCLE_ARTIFACTS: "./tmp"
+    steps:
+      - restore_cache:
+          key: v1-repo-{{ .Environment.CIRCLE_SHA1 }}
+      - restore_cache:
+          key: v1-bundle-{{ checksum "Gemfile" }}
+      - attach_workspace:
+          at: ~/coins_paid
+      - run: sudo apt-get update && sudo apt-get install -y libsodium-dev
+      - run: bundle check --path vendor/bundle
+      - run: bundle exec rspec spec
+      - run: ./cc/cc-test-reporter format-coverage -t simplecov -o cc/codeclimate.rspec.json tmp/coverage/.resultset.json
+      - persist_to_workspace:
+          root: ~/coins_paid
+          paths:
+            - cc/codeclimate.rspec.json
+
+  upload_cc_coverage:
+    <<: *defaults
+    steps:
+      - attach_workspace:
+          at: ~/coins_paid
+      - run:
+          name: Upload coverage results to Code Climate
+          command: |
+            ./cc/cc-test-reporter upload-coverage -i cc/codeclimate.rspec.json
+
+  deploy:
+    <<: *defaults
+    steps:
+      - restore_cache:
+          key: v1-repo-{{ .Environment.CIRCLE_SHA1 }}
+      - restore_cache:
+          key: v1-bundle-{{ checksum "Gemfile" }}
+      - run: mkdir -p ~/.ssh && ssh-keyscan -H github.com >> ~/.ssh/known_hosts
+      - run: sudo apt-get update && sudo apt-get install -y libsodium-dev
+      - run: bundle check --path vendor/bundle
+      - run: bundle exec rake deploy:branch_or_label
+
+workflows:
+  version: 2
+  build_test_deploy:
+    jobs:
+      - checkout_code
+      - download_cc_reporter:
+          requires:
+            - checkout_code
+      - run_bundler:
+          requires:
+            - download_cc_reporter
+      - run_rspec_tests:
+          requires:
+            - run_bundler
+      - upload_cc_coverage:
+          requires:
+            - run_rspec_tests

data/.gitignore

@@ -0,0 +1,3 @@
+/*.gem
+/Gemfile.lock
+**/test.db

data/.rspec

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

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://www.rubygems.org"
+
+gemspec
+
+group :test do
+  gem 'simplecov', require: false
+  gem 'sqlite3'
+  gem 'rspec-its'
+end

data/coins_paid_rails.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name = 'coins_paid_rails'
+  s.authors = ['Artem Biserov(artembiserov)', 'Oleg Ivanov(morhekil)']
+  s.version = '1.0.0'
+  s.files = `git ls-files`.split("\n")
+  s.summary = 'CoinsPaid Rails Integration'
+  s.license = 'MIT'
+
+  s.add_runtime_dependency 'coins_paid_api', '~> 1.0'
+  s.add_runtime_dependency 'activerecord', '>= 4.2.0'
+  s.add_runtime_dependency 'dry-initializer', '~> 3.0'
+  s.add_runtime_dependency 'dry-struct', '~> 1.0'
+  s.add_development_dependency 'rspec-rails', '~> 3.0'
+end
+

data/lib/coins_paid.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require 'dry-struct'
+require 'dry-initializer'
+require_relative 'coins_paid/address'
+require_relative 'coins_paid/coins_paid_address'
+require_relative 'coins_paid/qr_code'
+
+module CoinsPaid
+  module_function
+
+  UnknownCurrency = Class.new RuntimeError
+
+  DEFAULT_CONVERT_TO = ENV['COINS_PAID_CURRENCY']
+
+  CRYPTO_CURRENCIES = {
+    'BTC' => 'bitcoin',
+    'ETH' => 'ethereum',
+    'LTC' => 'litecoin'
+  }.freeze
+
+  def address(foreign_id, currency:)
+    Address.new(foreign_id: foreign_id, currency: currency, convert_to: DEFAULT_CONVERT_TO).call
+  end
+
+  def qr_code(player_id, currency:, label:, message:)
+    QrCode.new(player_id, currency: currency, label: label, message: message)
+  end
+
+  def currency(name)
+    CoinsPaid::API.currencies_list.find { |item| item.currency == name } || raise(UnknownCurrency, name)
+  end
+end

data/lib/coins_paid/address.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module CoinsPaid
+  class Address
+    module Types
+      include Dry.Types()
+    end
+
+    class Data < Dry::Struct
+      attribute :foreign_id, Types::Coercible::String
+      attribute :currency, Types::String
+      attribute :convert_to, Types::String
+    end
+
+    include Dry::Initializer.define -> do
+      param :request_data, Data
+    end
+
+    def call
+      CoinsPaidAddress.find_or_create_by!(request_data.attributes.slice(:foreign_id, :currency)) do |address|
+        response = CoinsPaid::API.take_address(request_data.attributes)
+        address.assign_attributes(response.attributes)
+      end
+    end
+  end
+end

data/lib/coins_paid/coins_paid_address.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module CoinsPaid
+  class CoinsPaidAddress < ActiveRecord::Base
+  end
+end

data/lib/coins_paid/qr_code.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module CoinsPaid
+  class QrCode
+    include Dry::Initializer.define -> do
+      param :player_id
+      option :currency
+      option :label
+      option :message
+    end
+
+    def url
+      "#{token_type}:#{address}?label=#{encode(label)}&message=#{encode(message)}"
+    end
+
+    def address
+      @address ||= CoinsPaid.address(player_id, currency: currency).address
+    end
+
+    def svg
+      RQRCode::QRCode.new(url).as_svg(
+        offset: 0,
+        color: '000',
+        shape_rendering: 'crispEdges',
+        module_size: 3,
+        standalone: true
+      )
+    end
+
+    private
+
+    def token_type
+      CRYPTO_CURRENCIES.fetch(currency)
+    end
+
+    def encode(string)
+      URI.encode_www_form_component(string)
+    end
+  end
+end

data/lib/coins_paid_rails.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require_relative 'coins_paid'

data/lib/generators/coins_paid/migration_data.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CoinsPaid
+  module MigrationData
+    module_function
+
+    def get
+<<RUBY
+    create_table :coins_paid_addresses do |t|
+      t.string :foreign_id, null: false
+      t.string :currency, null: false
+      t.string :address, null: false
+      t.string :tag
+      t.integer :external_id, null: false
+ 
+      t.timestamps
+      t.index [:foreign_id, :currency], unique: true
+    end
+RUBY
+    end
+  end
+end

data/lib/generators/coins_paid/migration_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'rails/generators/active_record'
+require_relative 'migration_data'
+
+module CoinsPaid
+  module Generators
+    class MigrationGenerator < ActiveRecord::Generators::Base
+      argument :name, default: 'create_coins_paid_addresses'
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_coins_paid_migration
+        migration_template 'migration.rb', "#{db_migrate_path}/#{file_name}.rb"
+      end
+
+      def migration_data
+        CoinsPaid::MigrationData.get
+      end
+    end
+  end
+end

data/lib/generators/coins_paid/templates/migration.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Create<%= table_name.camelize %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+<%= migration_data %>
+  end
+end

data/spec/address_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+describe CoinsPaid, '.address' do
+  let(:foreign_key) { 'user-id:2048' }
+  let(:currency) { 'BTC' }
+  let(:full_address_attributes) do
+    {
+      foreign_id: foreign_key,
+      currency: currency
+    }.merge(address_attributes)
+  end
+  let(:address_attributes) do
+    {
+      external_id: 1,
+      address: '12983h13ro1hrt24it432t',
+      tag: 'tag-123',
+    }
+  end
+  subject(:take_address) { described_class.address(foreign_key, currency: currency) }
+
+  context 'when there is existing record' do
+    let!(:address) do
+      CoinsPaid::CoinsPaidAddress.create!(full_address_attributes)
+    end
+
+    before do
+      allow(CoinsPaid::API).to receive(:take_address)
+    end
+
+    it 'returns existing record' do
+      expect(take_address).to eq address
+
+      expect(CoinsPaid::API).not_to have_received(:take_address)
+    end
+  end
+
+  context 'when coins paid api responds with error' do
+    before do
+      allow(CoinsPaid::API).to receive(:take_address).and_raise(CoinsPaid::API::Error)
+    end
+
+    it 'raises error' do
+      expect { take_address }.to raise_error(CoinsPaid::API::Error)
+    end
+  end
+
+  context 'when coins paid return valid response' do
+    before do
+      allow(CoinsPaid::API).to receive(:take_address).and_return(CoinsPaid::API::TakeAddress::Response.new(address_attributes))
+    end
+
+    it 'creates new address' do
+      expect(take_address).to have_attributes(full_address_attributes)
+    end
+  end
+end

data/spec/currency_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+describe CoinsPaid, '.currency' do
+  let(:eth) { instance_double(CoinsPaid::API::Currency, currency: 'ETH') }
+
+  subject(:currency) { described_class.currency(eth.currency) }
+
+  context 'when CoinsPaid API responds correctly' do
+    before do
+      allow(CoinsPaid::API).to receive(:currencies_list) { currencies }
+    end
+
+    context 'and currency exists at CoinsPaid' do
+      let(:currencies) do
+        [eth, instance_double(CoinsPaid::API::Currency, currency: 'm' + eth.currency)]
+      end
+
+      it 'returns requested currency details' do
+        expect(currency).to eq eth
+      end
+    end
+
+    context 'and currency does not exist at CoinsPaid' do
+      let(:currencies) do
+        [instance_double(CoinsPaid::API::Currency, currency: 'm' + eth.currency)]
+      end
+
+      it 'errors' do
+        expect { currency }.to raise_error(CoinsPaid::UnknownCurrency)
+      end
+    end
+  end
+
+  context 'when coins paid api errors' do
+    before do
+      allow(CoinsPaid::API).to receive(:currencies_list).and_raise(CoinsPaid::API::Error)
+    end
+
+    it 're-raises error' do
+      expect { currency }.to raise_error(CoinsPaid::API::Error)
+    end
+  end
+end

data/spec/qr_code_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+describe CoinsPaid, '.qr_code' do
+  let(:foreign_id) { 123 }
+  let(:coins_paid_address) do
+    instance_double CoinsPaid::CoinsPaidAddress,
+      currency: 'BTC',
+      address: 'abc123'
+  end
+  subject(:qr_code) do
+    described_class.qr_code(
+      foreign_id,
+      currency: 'BTC',
+      label: 'RedStar deposit',
+      message: 'Make a deposit to RedStar'
+    )
+  end
+
+  before do
+    allow(CoinsPaid).to receive(:address).with(foreign_id, currency: 'BTC').and_return(coins_paid_address)
+  end
+
+  describe '#payment_url' do
+    its(:url) { is_expected.to eq 'bitcoin:abc123?label=RedStar+deposit&message=Make+a+deposit+to+RedStar' }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+ENV['COINS_PAID_CURRENCY'] = 'EUR'
+
+if ENV['CIRCLE_ARTIFACTS']
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'active_record'
+require "active_record/railtie"
+require 'rspec/rails'
+require 'rspec/its'
+
+require 'coins_paid_api'
+require 'coins_paid_rails'
+
+Dir['./spec/support/**/*.rb'].each { |f| require f }
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: 'spec/test.db')
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+
+  config.before :suite do
+    CreateTable.migrate(:up)
+  end
+end

data/spec/support/database/create_table.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require_relative '../../../lib/generators/coins_paid/migration_data'
+
+class CreateTable < ActiveRecord::Migration[ActiveRecord::Migration.current_version]
+  def up
+    drop_table :coins_paid_addresses if table_exists?(:coins_paid_addresses)
+
+    migration_data
+  end
+
+  def migration_data
+    instance_eval CoinsPaid::MigrationData.get
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: coins_paid_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Artem Biserov(artembiserov)
+- Oleg Ivanov(morhekil)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coins_paid_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- coins_paid_rails.gemspec
+- lib/coins_paid.rb
+- lib/coins_paid/address.rb
+- lib/coins_paid/coins_paid_address.rb
+- lib/coins_paid/qr_code.rb
+- lib/coins_paid_rails.rb
+- lib/generators/coins_paid/migration_data.rb
+- lib/generators/coins_paid/migration_generator.rb
+- lib/generators/coins_paid/templates/migration.rb
+- spec/address_spec.rb
+- spec/currency_spec.rb
+- spec/qr_code_spec.rb
+- spec/spec_helper.rb
+- spec/support/database/create_table.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: CoinsPaid Rails Integration
+test_files: []