trackplus 1.0.0.pre.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9967e22895eb21494c52f99f246c0319a0317d3c62e7b126d52282d220c1018
+  data.tar.gz: 96b6f37f5d8622c137fadfd08bea8e65769d4f1367f95050b6b539917232a758
+SHA512:
+  metadata.gz: 5720be381c082430a7dfecb8e75e04af9db004ab74b1c7ccd6e48caef71d932335e2a1c3341da604e5fd1eb6cd08301f22b7c76d60ae4e4d78d7aef1afba2760
+  data.tar.gz: 23c048a2943ccc81da1910291deafaa9c181babcb1ef453bda4fd8ae44ec6cf43ccdf67e6b7315c1f3c88d8589d93d87a6b474b302e3aadb77c52b0aff7cbd76

data/README.md

@@ -0,0 +1,53 @@
+[![Code Climate](https://codeclimate.com/github/ammit/trackplus-ruby/badges/gpa.svg)](https://codeclimate.com/github/ammit/trackplus-ruby)
+[![Build Status](https://travis-ci.org/ammit/trackplus-ruby.svg?branch=master)](https://travis-ci.org/ammit/trackplus-ruby)
+
+# trackplus-ruby
+
+Dead-simple Ruby API client for Trackplus. No extra runtime dependencies.
+
+Uses v1 API provided by Trackplus.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trackplus', git: 'https://github.com/ammit/trackplus-ruby'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+## Usage
+
+Gem covers all traclings & available couriers api 
+
+#### Example
+
+``` ruby
+client = Trackplus::Client.new(api_key: 'api_key')
+
+# get supported couriers
+client.couriers
+
+# get tracking
+client.tracking(courier: 'airwings', tracking_no: '202315836553')
+
+
+# Possible errors (each one inherits from Trackplus::Errors::TrackplusError)
+Trackplus::Errors::InvalidConfiguration # missing api_key / subdomain
+Trackplus::Errors::NotAuthorized   # wrong api key
+Trackplus::Errors::InvalidResponse # something went wrong during the request?
+Trackplus::Errors::NotFound        # 404 from Trackplus
+Trackplus::Errors::RequestToLong   # When the requested result takes to long to calculate, try limiting your query
+```
+
+## Contributing
+1. Fork it ( https://github.com/ammit/trackplus-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/trackplus.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'uri'
+require 'net/http'
+require 'date'
+require 'ostruct'
+require 'cgi'
+require 'forwardable'
+
+require_relative 'trackplus/version'
+require_relative 'trackplus/transformation'
+require_relative 'trackplus/errors'
+require_relative 'trackplus/client'
+
+module Trackplus
+  API_VERSION = 1
+end

data/lib/trackplus/client.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Trackplus
+  class Client
+    def initialize(options = {})
+      @max_retries = options.fetch(:max_retries, 3)
+      @api_key = options.fetch(:api_key) { configuration_error 'Missing api_key argument' }
+      @transform_to = Transformation.new(options[:transform_to])
+    end
+
+    # returns a collection of your account members
+    def tracking(courier:, tracking_no:)
+      @transform_to.apply(nil, get_request("trackings/#{courier}/#{tracking_no}")['data'])
+    end
+
+    def couriers
+      @transform_to.apply(nil, get_request('couriers')['data'])
+    end
+
+    private
+
+    attr_reader :api_key
+
+    # do the get request to api
+    def get_request(url, params = {})
+      params = URI.encode_www_form(params.keep_if { |k, v| k && v })
+      full_url = params.empty? ? url : [url, params].join('?')
+      do_request(full_url, Net::HTTP::Get)
+    end
+
+    # generic part of requesting api
+    def do_request(url, type, &_block)
+      retries = 0
+      response = nil
+
+      uri = URI.parse("#{api_url}/#{url}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      # http.use_ssl = true
+
+      request = type.new(uri.request_uri, headers)
+
+      yield request if block_given?
+
+      http.start do |h|
+        begin
+          response = h.request(request)
+        rescue Errno::ECONNREFUSED, Net::ReadTimeout, Net::OpenTimeout => e
+          if (retries += 1) <= @max_retries
+            sleep(retries)
+            retry
+          else
+            raise Errors::MaxRetriesExceeded
+          end
+        ensure
+          h.finish if h
+        end
+      end
+
+      parse!(response)
+    end
+
+    # parse the api response
+    def parse!(response)
+      case response.code.to_i
+      when 204, 205
+        nil
+      when 200...300
+        JSON.parse(response.body) unless response.body.to_s.empty?
+      when 401
+        raise Errors::NotAuthorized, JSON.parse(response.body)['error']
+      when 404
+        raise Errors::NotFound, JSON.parse(response.body)['error']
+      when 422
+        handle_response_422(response)
+      when 503
+        raise Errors::RequestToLong, response.body
+      else
+        raise Errors::InvalidResponse, "Response code: #{response.code} message: #{response.body}"
+      end
+    end
+
+    # default headers for authentication and JSON support
+    def headers
+      {
+        'Accept' => 'application/json',
+        'Authorization' => "Bearer #{api_key}",
+        'Content-Type' => 'application/json',
+        'User-Agent' => 'Workable Ruby Client'
+      }
+    end
+
+    # build the url to api
+    def api_url
+      @_api_url ||= format('http://167.71.238.124/api/v%s', Trackplus::API_VERSION)
+    end
+
+    def configuration_error(message)
+      raise Errors::InvalidConfiguration, message
+    end
+  end
+end

data/lib/trackplus/errors.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trackplus
+  module Errors
+    class TrackplusError       < StandardError; end
+    class InvalidConfiguration < TrackplusError; end
+    class NotAuthorized        < TrackplusError; end
+    class InvalidResponse      < TrackplusError; end
+    class NotFound             < TrackplusError; end
+    class AlreadyExists        < TrackplusError; end
+    class RequestToLong        < TrackplusError; end
+    class MaxRetriesExceeded   < TrackplusError; end
+  end
+end

data/lib/trackplus/transformation.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Trackplus
+  class Transformation
+    def initialize(mappings)
+      @mappings = mappings || {}
+    end
+
+    # selects transformation strategy based on the inputs
+    # @param transformation [Method|Proc|nil] the transformation to perform
+    # @param data           [Hash|Array|nil]  the data to transform
+    # @return               [Object|nil]
+    #    results of the transformation if given, raw data otherwise
+    def apply(mapping, data)
+      transformation = @mappings[mapping]
+      return data unless transformation
+
+      case data
+      when nil
+        data
+      when Array
+        data.map { |datas| transformation.call(datas) }
+      else
+        transformation.call(data)
+      end
+    end
+  end
+end

data/lib/trackplus/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Trackplus
+  VERSION = '1.0.0-beta'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: trackplus
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.beta
+platform: ruby
+authors:
+- Amit Kosti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-21 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+description: Developed for easy integration with TrackPlus
+email:
+- akosti92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/trackplus.rb
+- lib/trackplus/client.rb
+- lib/trackplus/errors.rb
+- lib/trackplus/transformation.rb
+- lib/trackplus/version.rb
+homepage: https://github.com/ammit/trackplus-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements:
+- none
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Support the latest V1 API
+test_files: []