naspay_rails 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 593b96e218256a186c2488cf35a35546f1e0369224decf70f7ba8ab67f75d415
-  data.tar.gz: da635ee1cb8e0187d645c17216a8c63fbd309d468e6eee5e11c338bf9f8eee2b
+  metadata.gz: b311afec98ab5861fba8fb24a5731b2c44370ef107ed76961cb8ecc560b6f29c
+  data.tar.gz: f465013396e0dea0fb8fec45bcdccfe08ece0a8f7d92581ea32833aa39c4630f
 SHA512:
-  metadata.gz: e6f699f8c9c0d53e79a5892eef6c77fd3d0ab69c3a3b088066cf66c314703e559cd9b9774e23ac419a3535efd0b17bb06fb511d743cad2251b06c0fe02fc4999
-  data.tar.gz: dceae070c907cb4bcc6a34fc3075c3bf3654a8079ebeb7b723c7e758a438c98d0c30af80514d16e3430c5ad62e0a2546a5e7a6a1fa05758aa30b744c4bfe7046
+  metadata.gz: 91556c4998f98b0b4646d726d3bb967fc185dcb6cc44f5188b5bda7dfd3f18f8d762b1bc4c11f5851f4dc3effdc5e503fdcc44b8ff3ad60fcbc8712f211d8806
+  data.tar.gz: 02af568a5fc501552a9c9b061ebaf0ef0156ee162181225d7f966477a3d0994c44a54dfec47d2a3c666feb97c8bc3adaaeb4dc78ec921c23f8ae04edeb2ebe03

data/.gitignore

@@ -18,4 +18,3 @@
 
 # IDEa folder
 .idea/*
-

data/Gemfile

@@ -3,4 +3,3 @@ source "https://rubygems.org"
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in naspay_rails.gemspec
-gemspec

data/Gemfile.lock

@@ -1,35 +1,11 @@
-PATH
-  remote: .
-  specs:
-    naspay_rails (0.1.6)
-
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
-  naspay_rails!
-  rake (~> 10.0)
-  rspec (~> 3.0)
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -1,38 +1,101 @@
 # NaspayRails
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/naspay_rails`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+**NaspayRails** is a Ruby library for Naspay Client-to-Server API interaction with handful 
+HTTP/JSON/JWT wrappers, access credentials protection through namespaced classes as standalone 
+services reflecting basic API routes, actions and requests.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+NaspayRails is hosted on [rubygems](https://rubygems.org/) and installs with bundler (Gemfile):
 
-```ruby
-gem 'naspay_rails'
-```
+    gem 'naspay_rails'
+or manually:
 
-And then execute:
+    $ gem install naspay_rails
 
-    $ bundle
+Assuming that the project is run on **Rails (>= 5.1.5)**, please `require 'naspay_rails'` at `application.rb` level and 
+run the below command:
+ 
+    $ bundle exec naspay_rails_init
 
-Or install it yourself as:
+It adds the following files to the project:
 
-    $ gem install naspay_rails
+1. `config/naspay.yml` keeps secure credentials for each environment. Please fill it with data like this:
+
+        development:  
+          api_endpoint: https://demo.naspay.net
+          api_login: login       
+          api_password:  password
+          merchant_login: merchant_login
+          merchant_password: merchant_pass
+
+2. `config/initializers/naspay_rails.rb` makes us able to run `NaspayRails.configuration` anywhere in our App
+and receive a dynamically generated class `NaspayRails::Configuration` with the attributes you entered above:
+
+        @secrets=
+          {:api_endpoint=>"https://demo.naspay.net",
+           :api_login=>"login",
+           :api_password=>"password",
+           :merchant_login=>"merchant_login",
+           :merchant_password=>"merchant_pass"
+
+This how sensitive data processing works
 
 ## Usage
+### Modules and mixins
+
+GEM has a dedicated module for each API route namespace along with *module* methods representing actions, e.g. :
+
+        NaspayRails::Auth
+            methods: .get_token
+        NaspayRails::Transactions
+            methods: .get_list, .create_new(endpoint, params, token)
+        
+And separate own master level methods and configuration namespaces: 
+
+         NaspayRails
+            methods: .configure, .configuration
+         
+         NaspayRails::Configuration
+            attr_accessor :secrets
+
+### Dealing with Naspay JWT tokens
+
+First of all, getting 1-time JWT token from Naspay for any further API request looks like this (try out from rails console):
+
+        secrets     = NaspayRails.configuration.secrets
+        auth_token  = NaspayRails::Auth.get_token(secrets)
+ 
+returns string value of a token 
+
+        => "really-long-jwt-string"
+
+### Transactions
+
+1. Getting the list of transactions via **GET** `/api/v1/transactions`:
+
+   After `require 'naspay_rails'` on application level, a mixed-in module is available throughout the App. Its
+   `.get_list` method accepts `endpoint` and `token` *strings* as arguments:
+
+        NaspayRails::Transactions.get_list(endpoint, token)
+
+   Response is a parsed **JSON** collection of latest transactions
+
+2. Creating new transaction via **POST** `/api/v1/transactions`:
+
+   Request for a new payment accepts `endpoint`, `token` *strings* and `params` *hash*
 
-TODO: Write usage instructions here
+        NaspayRails::Transactions.create_new(endpoint, params, token)
 
-## Development
+   Please note that `params` *hash* keys should be `:symbols`. The below keys are required:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+        :intent, :amount, :currency, :transaction_id, :description
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+   All required keys except `:amount` should contain *string* values. Amount value is `BigDecimal`, e.g. `11.00`
 
-## Contributing
+   `params` *hash* also takes optional keys:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/naspay_rails.
+        :customer, :shipping_address
 
 ## License
 

data/bin/naspay_rails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "naspay_rails/cli"
+
+NaspayRails::CLI.start

data/exe/naspay_rails_init

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require "naspay_rails"
+
+# get Rails application folder
+rails_folder      = ENV['PWD']
+
+# add naspay.yml file to the project
+yaml_file         = 'naspay.yml'
+yaml_folder       = File.expand_path('../../lib/config_files',__FILE__)
+target_yaml_file  = File.join(yaml_folder, yaml_file)
+rails_yaml_file   = File.join(rails_folder, 'config', yaml_file)
+FileUtils.cp_r target_yaml_file, rails_yaml_file
+
+# add naspay.rb initializer to the project
+rb_file           = 'naspay_rails.rb'
+rb_folder         = File.expand_path('../../lib/initializers',__FILE__)
+target_rb_file    = File.join(rb_folder, rb_file)
+rails_rb_file     = File.join(rails_folder, 'config/initializers', rb_file)
+FileUtils.cp_r target_rb_file, rails_rb_file
+
+# gitignore naspay.yml
+ignore_file = '.gitignore'
+File.exist?(ignore_file) ?  File.open(ignore_file, 'a') { |f| f << "\n# Ignore naspay.yml sensitive data\n/config/naspay.yml\n" } : return

data/lib/config_files/naspay.yml

@@ -0,0 +1,20 @@
+development:
+  api_endpoint:
+  api_login:
+  api_password:
+  merchant_login:
+  merchant_password:
+
+test:
+  api_endpoint:
+  api_login:
+  api_password:
+  merchant_login:
+  merchant_password:
+
+production:
+  api_endpoint:
+  api_login:
+  api_password:
+  merchant_login:
+  merchant_password:

data/lib/initializers/naspay_rails.rb

@@ -0,0 +1,5 @@
+NaspayRails.configure do |config|
+  config.secrets = Rails.application.config_for(:naspay).each_with_object({}) do |(k,v), h|
+    h[k.to_sym] = v
+  end
+end

data/lib/naspay_rails.rb

@@ -1,5 +1,15 @@
-require "naspay_rails/version"
+require 'naspay_rails/version'
+require 'naspay_rails/configuration'
+require 'naspay_rails/auth'
+require 'naspay_rails/transactions'
 
 module NaspayRails
-  # Your code goes here...
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
 end

data/lib/naspay_rails/auth.rb

@@ -0,0 +1,27 @@
+require 'net/http'
+require 'uri'
+
+module NaspayRails
+  module Auth
+    def self.get_token(params)
+      route_suffix  = '/auth/token'
+      target_url    = "#{params[:api_endpoint]}#{route_suffix}"
+      request_uri   = URI.parse(target_url)
+      request       = Net::HTTP::Get.new(request_uri)
+      request.basic_auth(
+          params[:api_login],
+          params[:api_password]
+      )
+      request['Accept'] = 'application/json'
+      request.set_form_data(
+          'grant_type' => 'client_credentials'
+      )
+      req_options = {
+          use_ssl: request_uri.scheme == 'https'
+      }
+      Net::HTTP.start(request_uri.hostname, request_uri.port, req_options) {
+          |http| JSON.parse(http.request(request).body).values.first
+      }
+    end
+  end
+end

data/lib/naspay_rails/configuration.rb

@@ -0,0 +1,6 @@
+module NaspayRails
+  class Configuration
+    attr_accessor :secrets
+
+  end
+end

data/lib/naspay_rails/transactions.rb

@@ -0,0 +1,92 @@
+require 'net/http'
+require 'uri'
+
+module NaspayRails
+  module Transactions
+    def self.get_list(endpoint, token)
+      route_suffix = '/api/v1/transactions'
+      target_url   = "#{endpoint}#{route_suffix}"
+      request_uri   = URI.parse(target_url)
+      request       = Net::HTTP::Get.new(request_uri)
+      request["Authorization"] = "Bearer #{token}"
+      req_options = {
+          use_ssl: request_uri.scheme == 'https'
+      }
+      Net::HTTP.start(request_uri.hostname, request_uri.port, req_options) {
+          |http| JSON.parse(http.request(request).body)
+      }
+    end
+
+    def self.create_new(endpoint, params, token)
+      route_suffix = '/api/v1/transactions'
+      target_url   = "#{endpoint}#{route_suffix}"
+      request_uri  = URI.parse(target_url)
+      request      = Net::HTTP::Post.new(request_uri)
+      request["Authorization"] = "Bearer #{token}"
+      request["Content-Type"]  = "application/json"
+      request["Accept"]        = "application/json"
+
+      request_body =
+          case params.keys.sort
+              when %i[intent amount currency transaction_id description].sort
+              {
+                  "intent"                 => params[:intent],
+                  "amount"                 => params[:amount],
+                  "currency"               => params[:currency],
+                  "merchantTransactionId"  => params[:transaction_id],
+                  "description"            => params[:description]
+              }
+            when %i[intent amount currency transaction_id description customer].sort
+              {
+                  "intent"                 => params[:intent],
+                  "amount"                 => params[:amount],
+                  "currency"               => params[:currency],
+                  "merchantTransactionId"  => params[:transaction_id],
+                  "description"            => params[:description],
+                  "customer" => {
+                      "email"               => params[:customer].try(:[], :email),
+                      "phone"               => params[:customer].try(:[], :phone),
+                      "merchantCustomerId"  => params[:customer].try(:[], :customer_id),
+                      "locale"              => params[:customer].try(:[], :locale),
+                      "ip"                  => params[:customer].try(:[], :ip)
+                  }
+              }
+            when %i[intent amount currency transaction_id description customer shipping_address].sort
+              {
+                  "intent"                 => params[:intent],
+                  "amount"                 => params[:amount],
+                  "currency"               => params[:currency],
+                  "merchantTransactionId"  => params[:transaction_id],
+                  "description"            => params[:description],
+
+                  "customer" => {
+                      "email"               => params[:customer].try(:[], :email),
+                      "phone"               => params[:customer].try(:[], :phone),
+                      "merchantCustomerId"  => params[:customer].try(:[], :customer_id),
+                      "locale"              => params[:customer].try(:[], :locale),
+                      "ip"                  => params[:customer].try(:[], :ip)
+                  },
+
+                  "shippingAddress" => {
+                      "line1"         => params[:shipping_address].try(:[], :line1),
+                      "line2"         => params[:shipping_address].try(:[], :line2),
+                      "city"          => params[:shipping_address].try(:[], :city),
+                      "countryCode"   => params[:shipping_address].try(:[], :country_code),
+                      "postalCode"    => params[:shipping_address].try(:[], :postal_code),
+                      "state"         => params[:shipping_address].try(:[], :state),
+                      "phone"         => params[:shipping_address].try(:[], :phone),
+                      "recipientName" => params[:shipping_address].try(:[], :recipient_name)
+                  }
+              }
+            else
+              return 'please check the keys provided in params Hash!'
+          end
+      request.body = JSON.dump(request_body)
+      req_options = {
+          use_ssl: request_uri.scheme == "https",
+      }
+
+      Net::HTTP.start(request_uri.hostname, request_uri.port, req_options) { |http| http.request(request) }
+    end
+  end
+end

data/lib/naspay_rails/version.rb

@@ -1,3 +1,3 @@
 module NaspayRails
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/naspay_rails.gemspec

@@ -8,7 +8,6 @@ Gem::Specification.new do |spec|
   spec.version       = NaspayRails::VERSION
   spec.authors       = ["antonror"]
   spec.email         = ["antonmailingbox@gmail.com"]
-
   spec.summary       = %q{Naspay API interaction tool}
   spec.description   = %q{Ruby library for Naspay API}
   spec.homepage      = "https://naspay.com/"
@@ -30,7 +29,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency "thor", "~> 0.19.1"
+
+  spec.executables << 'naspay_rails_init'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naspay_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - antonror
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,11 +52,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
 description: Ruby library for Naspay API
 email:
 - antonmailingbox@gmail.com
 executables:
-- naspay_rails
+- naspay_rails_init
 extensions: []
 extra_rdoc_files: []
 files:
@@ -71,10 +85,15 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/naspay_rails
 - bin/setup
-- exe/naspay_rails
+- exe/naspay_rails_init
 - lib/config_files/naspay.yml
+- lib/initializers/naspay_rails.rb
 - lib/naspay_rails.rb
+- lib/naspay_rails/auth.rb
+- lib/naspay_rails/configuration.rb
+- lib/naspay_rails/transactions.rb
 - lib/naspay_rails/version.rb
 - naspay_rails.gemspec
 homepage: https://naspay.com/
@@ -90,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/exe/naspay_rails

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-
-require "naspay_rails"
-
-
-file_name    = 'naspay.yml'
-
-yaml_folder  = File.expand_path('../../lib/config_files',__FILE__)
-yaml_file    = File.join(yaml_folder, file_name)
-
-rails_folder = ENV['PWD']
-rails_file   = File.join(rails_folder, 'config', file_name)
-
-
-FileUtils.cp_r yaml_file, rails_file