jurnal_api 0.1.0

data/lib/jurnal_api/configuration.rb

@@ -0,0 +1,92 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module JurnalApi
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {JurnalApi::API}
+    VALID_OPTIONS_KEYS = [
+      :access_token,
+      :adapter,
+      :api_version,
+      :base_url,
+      :connection_options,
+      :authorization_path,
+      :format,
+      :user_agent,
+      :no_response_wrapper
+    ].freeze
+
+    # By default, don't set a user access token
+    DEFAULT_ACCESS_TOKEN = nil
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set any connection options
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note There is no reason to use any other endpoint at this time
+    DEFAULT_URL = 'https://sandbox-api.jurnal.id'.freeze
+
+    DEFAULT_AUTHORIZATION_PATH = 'core'.freeze
+
+    # By default, don't wrap responses with meta data (i.e. pagination)
+    DEFAULT_NO_RESPONSE_WRAPPER = false
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is the only available format at this time
+    DEFAULT_FORMAT = :json
+
+    DEFAULT_VERSION = 'api/v1'
+
+    # By default, don't wrap responses with meta data (i.e. pagination)
+
+
+    # An array of valid request/response formats
+    #
+    # @note Not all methods support the XML format.
+    VALID_FORMATS = [:json].freeze
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Jurnal Ruby Gem #{JurnalApi::VERSION}".freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.access_token        = ENV['JURNAL_COMPANY_API_KEY'] || DEFAULT_ACCESS_TOKEN
+      self.adapter             = DEFAULT_ADAPTER
+      self.api_version         = DEFAULT_VERSION
+      self.authorization_path  = DEFAULT_AUTHORIZATION_PATH
+      self.connection_options  = DEFAULT_CONNECTION_OPTIONS
+      self.base_url            = ENV['JURNAL_API_BASE_URL'] || DEFAULT_URL
+      self.format              = DEFAULT_FORMAT
+      self.no_response_wrapper = DEFAULT_NO_RESPONSE_WRAPPER
+      self.user_agent          = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/jurnal_api/connection.rb

@@ -0,0 +1,43 @@
+require 'faraday_middleware'
+
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module JurnalApi
+  # @private
+  module Connection
+    private
+
+    def connection(raw = false)
+      basic_headers = {
+        'Accept'      => "application/#{format}; charset=utf-8",
+        'User-Agent'  => user_agent
+      }
+
+      options = { headers: basic_headers, url: endpoint }.merge(connection_options)
+
+      Faraday::Connection.new(options) do |connection|
+        # SET middlewares first
+        connection.response   :logger
+        connection.use        FaradayMiddleware::RaiseHttpException
+        connection.use        Faraday::Request::UrlEncoded
+
+        unless raw
+          case format.to_s.downcase
+            when 'json' then connection.use FaradayMiddleware::ParseJson
+          end
+        end
+
+        # ...then the adapter
+        # this is to maintain the API of Faraday v1
+        connection.adapter adapter
+
+        case authorization_path
+        when 'partner/core'
+          connection.headers['Authorization'] = "Bearer #{access_token}"
+        when 'core'
+          connection.headers['apikey'] = "#{access_token}"
+        end        
+      end
+    end
+  end
+end

data/lib/jurnal_api/error.rb

@@ -0,0 +1,46 @@
+module JurnalApi
+  # Custom error class for rescuing from all Jurnal errors
+  class Error < StandardError; end
+  class ErrorWithBody < Error
+    attr_reader :body
+
+    def initialize(msg = "", body = {})
+      @body = body
+
+      super(msg)
+    end    
+  end
+
+  # Raised when Jurnal returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Jurnal returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Jurnal returns the HTTP status code 409
+  class Conflict < ErrorWithBody; end
+
+  # Raised when Jurnal returns the HTTP status code 422
+  class UnprocessableEntity < ErrorWithBody; end
+
+  # Raised when Jurnal returns the HTTP status code 429
+  class TooManyRequests < Error; end
+
+  # Raised when Jurnal returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Jurnal returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when Jurnal returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when Jurnal returns the HTTP status code 504
+  class GatewayTimeout < Error; end
+
+  # Raised when a subscription payload hash is invalid
+  class InvalidSignature < Error; end
+
+  # Raised when Jurnal returns the HTTP status code 429
+  class RateLimitExceeded < Error; end
+end

data/lib/jurnal_api/request.rb

@@ -0,0 +1,54 @@
+require 'openssl'
+require 'base64'
+
+module JurnalApi
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={}, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper())
+      request(:get, path, options, raw, unformatted, no_response_wrapper)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={}, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper())
+      request(:post, path, options, raw, unformatted, no_response_wrapper)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={},  raw=false, unformatted=false, no_response_wrapper=no_response_wrapper())
+      request(:put, path, options, raw, unformatted, no_response_wrapper)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={}, raw=false, unformatted=false, no_response_wrapper=no_response_wrapper())
+      request(:delete, path, options, raw, unformatted, no_response_wrapper)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options, raw=false, unformatted=false, no_response_wrapper=false)
+      response = connection(raw).send(method) do |request|
+        path = formatted_path(path) unless unformatted
+
+        case method
+        when :get, :delete
+          request.url(URI.encode(path), options)
+        when :post, :put
+          request.path = URI.encode(path)
+          request.headers['Content-Type'] = 'application/json'
+          request.body = options unless options.empty?
+        end
+      end
+
+      return response if raw
+      return response.body if no_response_wrapper
+      return Response.create( response.body, {:limit => response.headers['x-ratelimit-limit'].to_i,
+                                              :remaining => response.headers['x-ratelimit-remaining'].to_i} )
+    end
+
+    def formatted_path(path)
+      [path, format].compact.join('.')
+    end
+  end
+end

data/lib/jurnal_api/response.rb

@@ -0,0 +1,25 @@
+module JurnalApi
+  module Response
+    def self.create( response_hash, ratelimit_hash )
+      return {} if response_hash.nil?
+
+      data = response_hash.data.dup rescue response_hash
+      data.extend( self )
+      data.instance_exec do
+        %w{pagination meta}.each do |k|
+          response_hash.public_send(k).tap do |v|
+            instance_variable_set("@#{k}", v) if v
+          end
+        end
+
+        @ratelimit = ratelimit_hash
+      end
+
+      data
+    end
+
+    attr_reader :pagination
+    attr_reader :meta
+    attr_reader :ratelimit
+  end
+end

data/lib/jurnal_api/version.rb

@@ -0,0 +1,3 @@
+module JurnalApi
+  VERSION = '0.1.0'.freeze unless defined?(::JurnalApi::VERSION)
+end

metadata

@@ -0,0 +1,254 @@
+--- !ruby/object:Gem::Specification
+name: jurnal_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mekari-devs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+description: 
+email:
+- developer@mekari.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.template"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jurnal-api.gemspec
+- lib/faraday/raise_http_exception.rb
+- lib/jurnal_api.rb
+- lib/jurnal_api/api.rb
+- lib/jurnal_api/client.rb
+- lib/jurnal_api/client/customers.rb
+- lib/jurnal_api/client/journal_entries.rb
+- lib/jurnal_api/client/products.rb
+- lib/jurnal_api/client/receive_payments.rb
+- lib/jurnal_api/client/recurring_schedules.rb
+- lib/jurnal_api/client/sales_invoices.rb
+- lib/jurnal_api/client/sales_order_payments.rb
+- lib/jurnal_api/client/sales_orders.rb
+- lib/jurnal_api/configuration.rb
+- lib/jurnal_api/connection.rb
+- lib/jurnal_api/error.rb
+- lib/jurnal_api/request.rb
+- lib/jurnal_api/response.rb
+- lib/jurnal_api/version.rb
+homepage: https://github.com/mekari-engineering/jurnal_api
+licenses: []
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Jurnal API.
+test_files: []