merchant-zip 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 373ec98199100d662c6529821f8b1ac5a207043095f2efac34d718594d366db7
-  data.tar.gz: 15f780e751600c89143449ae71f157a7ff0bef6a800e745538af8c601ba48aca
+  metadata.gz: 1dc22e52da8cfb73cbe203767916bf171076fade8cb6f81f4b04095fd988736a
+  data.tar.gz: 9821f6cb85e1c6f1a8231efce7b6afaec1826f7826f38383bbcac034a00161c5
 SHA512:
-  metadata.gz: 6bfc3215600572d464c94339a16096510c253f0001d5aeefb9f9bba2c6794f191322443d5e3e321a1224c9d73415064826cd70fb3705b660ab65f8186ab8728f
-  data.tar.gz: ac51bf7fdff001a5b2343491c5783ddc517d489673e8ef7e1f92783c7dbfb4ade3f40e3e202511d46cb93daa9e66e33b1afc7da09774ce19043ad678662e5802
+  metadata.gz: dac62f52ab8d0fed9a5abe0aa3104efc76f1779bf8a0f15fc185d0fc9430230d6387c565fcd971b08d529b0b60dfe066e307a05a56b699396693326a61a92cad
+  data.tar.gz: 55415b5fc8cb0bc452111c903ce03b7ef3a414d028065724a7dba4c53937904b8d8932479493309ca1d1b97fe74d0bb6404014c2400aa45c1e359b36713713fa

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 DevHub
+
+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/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "irb"
+require_relative "../lib/merchant-zip"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+IRB.start(__FILE__)

data/lib/merchant-zip/api_resource.rb

@@ -0,0 +1,9 @@
+module MerchantZip
+  class ApiResource
+    include MerchantZip::Operations::Request
+
+    def self.class_name
+      self.name.split('::')[-1]
+    end
+  end
+end

data/lib/merchant-zip/charge.rb

@@ -0,0 +1,24 @@
+module MerchantZip
+  class Charge < ApiResource
+    extend MerchantZip::Operations::Get
+
+    def self.resource_url
+      "/#{CGI.escape(class_name.tableize)}"
+    end
+
+    def self.create(params = {}, opts = {})
+      payload = {
+        authority: {
+          type: "checkout_id",
+          value: params[:checkout_id],
+        },
+        reference: params[:reference],
+        amount: params[:amount],
+        currency: params[:currency].to_s.upcase,
+        capture: true,
+      }
+
+      request(:post, resource_url, payload, opts)
+    end
+  end
+end

data/lib/merchant-zip/checkout.rb

@@ -0,0 +1,31 @@
+module MerchantZip
+  class Checkout < ApiResource
+    extend MerchantZip::Operations::Get
+
+    def self.resource_url
+      "/#{CGI.escape(class_name.tableize)}"
+    end
+
+    def self.create(params = {}, opts = {})
+      payload = {
+        shopper: shopper_params(params),
+        order: {
+          reference: params[:reference],
+          amount: params[:amount],
+          currency: params[:currency].to_s.upcase,
+        }.merge(params.slice(:items, :shipping)),
+        config: {
+          redirect_uri: params[:callback_url],
+        }
+      }
+
+      request(:post, resource_url, payload, opts)
+    end
+
+    private
+
+    def self.shopper_params(params = {})
+      params.slice(:title, :first_name, :last_name, :email, :phone, :billing_address)
+    end
+  end
+end

data/lib/merchant-zip/client.rb

@@ -0,0 +1,76 @@
+require "forwardable"
+
+module MerchantZip
+  class Client
+    extend Forwardable
+
+    DEFAULT_API_MODE     = :live
+    API_MODES            = [:live, :sandbox]
+    DEFAULT_API_ENDPOINT = {
+      sandbox: "https://global-api.sand.au.edge.zip.co/merchant",
+      live: "https://global-api.prod.au.edge.zip.co/merchant"
+    }
+
+    attr_reader :config
+
+    def_delegators :@config, :mode, :mode=
+    def_delegators :@config, :api_key, :api_key=
+
+    def initialize(config = {})
+      @config = case config
+                when Hash
+                  MerchantZip.config.reverse_duplicate_merge(config)
+                when MerchantZip::Configuration
+                  config
+                else
+                  MerchantZip.config.dup
+                end
+    end
+
+    def api_mode
+      if API_MODES.include?(mode&.to_sym)
+        mode.to_sym
+      else
+        DEFAULT_API_MODE
+      end
+    end
+
+    def api_base
+      DEFAULT_API_ENDPOINT[api_mode]
+    end
+
+    def execute_request(method, url, params = {}, opts = {})
+      request_opts = opts
+      headers = {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{api_key}",
+        "idempotency-key" => SecureRandom.base64(18),
+      }
+
+      request_url = api_base + url.to_s
+
+      case method.to_s.downcase.to_sym
+      when :get, :head, :delete
+        # Make params into GET parameters
+        request_url += "#{URI.parse(url).query ? '&' : '?'}#{Util.encode_parameters(params)}" if params && params.any?
+        payload = nil
+      else
+        payload = params
+      end
+
+      payload = payload.to_json if payload.is_a?(Hash)
+
+      request_opts.update(method: method,
+                          headers: headers,
+                          payload: payload,
+                          url: request_url)
+
+      response = RestClient::Request.execute(request_opts)
+
+      JSON.parse(response.body, object_class: OpenStruct)
+    rescue => e
+      puts e.response
+      raise
+    end
+  end
+end

data/lib/merchant-zip/configuration.rb

@@ -0,0 +1,26 @@
+module MerchantZip
+  class Configuration
+    attr_accessor :mode
+    attr_accessor :api_key
+
+    def self.setup
+      new.tap do |instance|
+        yield(instance) if block_given?
+      end
+    end
+
+    # Create a new config based off an existing one. This is useful when the
+    # caller wants to override the global configuration
+    def reverse_duplicate_merge(hash)
+      dup.tap do |instance|
+        hash.each do |option, value|
+          instance.public_send("#{option}=", value)
+        end
+      end
+    end
+
+    def initialize
+      @mode = :live
+    end
+  end
+end

data/lib/merchant-zip/operations/create.rb

@@ -0,0 +1,9 @@
+module MerchantZip
+  module Operations
+    module Create
+      def create(params = {}, opts = {})
+        request(:post, resource_url, params, opts)
+      end
+    end
+  end
+end

data/lib/merchant-zip/operations/get.rb

@@ -0,0 +1,9 @@
+module MerchantZip
+  module Operations
+    module Get
+      def get(id, params = {})
+        request(:get, "#{resource_url}/#{CGI.escape(id)}", params)
+      end
+    end
+  end
+end

data/lib/merchant-zip/operations/request.rb

@@ -0,0 +1,22 @@
+module MerchantZip
+  module Operations
+    module Request
+      module ClassMethods
+        def request(method, url, params = {}, opts = {})
+          MerchantZip::Client.new.execute_request(method, url, params, opts)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      protected
+
+      def request(method, url, params = {}, opts = {})
+        opts = @opts.merge(opts)
+        self.class.request(method, url, params, opts)
+      end
+    end
+  end
+end

data/lib/merchant-zip/util.rb

@@ -0,0 +1,57 @@
+module MerchantZip
+  module Util
+    # Encodes a hash of parameters in a way that's suitable for use as query
+    # parameters in a URI or as form parameters in a request body. This mainly
+    # involves escaping special characters from parameter keys and values (e.g.
+    # `&`).
+    def self.encode_parameters(params)
+      Util.flatten_params(params).
+        map { |k,v| "#{url_encode(k)}=#{url_encode(v)}" }.join('&')
+    end
+
+    # Encodes a string in a way that makes it suitable for use in a set of
+    # query parameters in a URI or in a set of form parameters in a request
+    # body.
+    def self.url_encode(key)
+      CGI.escape(key.to_s).
+        # Don't use strict form encoding by changing the square bracket control
+        # characters back to their literals. This is fine by the server, and
+        # makes these parameter strings easier to read.
+        gsub('%5B', '[').gsub('%5D', ']')
+    end
+
+    def self.flatten_params(params, parent_key=nil)
+      result = []
+
+      # do not sort the final output because arrays (and arrays of hashes
+      # especially) can be order sensitive, but do sort incoming parameters
+      params.each do |key, value|
+        calculated_key = parent_key ? "#{parent_key}[#{key}]" : "#{key}"
+        if value.is_a?(Hash)
+          result += flatten_params(value, calculated_key)
+        elsif value.is_a?(Array)
+          check_array_of_maps_start_keys!(value)
+          result += flatten_params_array(value, calculated_key)
+        else
+          result << [calculated_key, value]
+        end
+      end
+
+      result
+    end
+
+    def self.flatten_params_array(value, calculated_key)
+      result = []
+      value.each do |elem|
+        if elem.is_a?(Hash)
+          result += flatten_params(elem, "#{calculated_key}[]")
+        elsif elem.is_a?(Array)
+          result += flatten_params_array(elem, calculated_key)
+        else
+          result << ["#{calculated_key}[]", elem]
+        end
+      end
+      result
+    end
+  end
+end

data/lib/merchant-zip/version.rb

@@ -0,0 +1,3 @@
+module MerchantZip
+  VERSION = "0.0.2"
+end

data/lib/merchant-zip.rb

@@ -0,0 +1,34 @@
+require "forwardable"
+
+require "merchant-zip/operations/request"
+require "merchant-zip/operations/create"
+require "merchant-zip/operations/get"
+require "merchant-zip/api_resource"
+require "merchant-zip/configuration"
+require "merchant-zip/version"
+require "merchant-zip/util"
+
+module MerchantZip
+  autoload :Client, "merchant-zip/client"
+  autoload :Checkout, "merchant-zip/checkout"
+  autoload :Charge, "merchant-zip/charge"
+
+  @config = Configuration.setup
+
+  class << self
+    extend Forwardable
+
+    attr_reader :config
+
+    # User configurable options
+    def_delegators :@config, :mode, :mode=
+    def_delegators :@config, :api_key, :api_key=
+
+    def configure(mode: :live, api_key: nil)
+      @config = Configuration.setup.reverse_duplicate_merge(
+        mode: mode,
+        api_key: api_key,
+      )
+    end
+  end
+end

data/merchant-zip.gemspec

@@ -0,0 +1,31 @@
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
+
+require "merchant-zip/version"
+
+Gem::Specification.new do |s|
+  s.name          = "merchant-zip"
+  s.version       = MerchantZip::VERSION
+  s.authors       = ["Devhub"]
+  s.email         = ["info@devhub.co"]
+  s.summary       = "Ruby Library for Zip API"
+  s.description   = "Merchant Zip provides Ruby APIs dealing with Zip transactions."
+  s.homepage      = "https://github.com/DevHubCo/merchant-zip"
+  s.license       = 'MIT'
+
+  ignored = Regexp.union(
+    /\A\.editorconfig/,
+    /\A\.git/,
+    /\A\.rubocop/,
+    /\A\.travis.yml/,
+    /\A\.vscode/,
+    /\Atest/
+  )
+
+  puts `git ls-files`.split("\n").reject { |f| ignored.match(f) }
+  s.files         = `git ls-files`.split("\n").reject { |f| ignored.match(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n")
+                                           .map { |f| ::File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rest-client', '~> 2.0', '>= 2.0.0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: merchant-zip
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Devhub
@@ -33,10 +33,25 @@ dependencies:
 description: Merchant Zip provides Ruby APIs dealing with Zip transactions.
 email:
 - info@devhub.co
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE
+- bin/console
+- lib/merchant-zip.rb
+- lib/merchant-zip/api_resource.rb
+- lib/merchant-zip/charge.rb
+- lib/merchant-zip/checkout.rb
+- lib/merchant-zip/client.rb
+- lib/merchant-zip/configuration.rb
+- lib/merchant-zip/operations/create.rb
+- lib/merchant-zip/operations/get.rb
+- lib/merchant-zip/operations/request.rb
+- lib/merchant-zip/util.rb
+- lib/merchant-zip/version.rb
+- merchant-zip.gemspec
 homepage: https://github.com/DevHubCo/merchant-zip
 licenses:
 - MIT