wing.rb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 751c45ed1de71b19c8d603fdd747e433d16740cd6343fd07ba3be53a10ed4a50
+  data.tar.gz: 25610c4279bd7556a1eb707cd614c684d66c2d77116e27bbebb883ce3e94eb48
+SHA512:
+  metadata.gz: 96db770ece76403c5e1d20119eade878d36490434cbe246e37fda80a413a36a03f9189266259f6835e9a8251dc80e4232d91eba8f1a4a1cf4dbc3b0f15eac1fe
+  data.tar.gz: 719e6d38a10746ede63e9a1cff73fea68ba7b2ca9cb2cfed12425d63705610629c1b14781070f2d4ae62bb3af658f864d1be5dc4ae13f49edcaf3aec3373fb37

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in wing.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    wing-ruby (0.1.0)
+      httparty (~> 0.16.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (1.0.0)
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    multi_xml (0.6.0)
+    public_suffix (4.0.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    safe_yaml (1.0.5)
+    webmock (3.8.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  webmock (~> 3)
+  wing-ruby!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Kevin Chavanne
+
+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/README.md

@@ -0,0 +1,40 @@
+# Wing
+
+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/wing`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wing'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install wing
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wing.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wing"
+
+# 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
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wing.rb

@@ -0,0 +1,23 @@
+require "wing/configuration"
+require "wing/version"
+require "wing/client"
+
+module Wing
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset_configuration
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/wing/actions.rb

@@ -0,0 +1,7 @@
+module Wing
+  module Actions
+  end
+end
+
+require_relative "actions/orders"
+require_relative "actions/stores"

data/lib/wing/actions/orders.rb

@@ -0,0 +1,33 @@
+module Wing
+  module Actions
+    module Orders
+      def list_orders(options = { page: 1, limit: 20, createdBefore: nil, createdAfter: nil, sort: nil })
+        get("/order", query: prepare_query(options)).parsed_response
+      end
+
+      def get_order(order_id)
+        get("/order/#{order_id}").parsed_response
+      end
+
+      def create_order(data, options = {})
+        post("/order", data, options).parsed_response
+      end
+
+      def generate_return_sticker(order_id:)
+        post("/a/awb/#{order_id}?returnLabel=true").parsed_response
+      end
+
+      private
+
+      def prepare_query(options = { page: 1, limit: 20, createdBefore: nil, createdAfter: nil, sort: nil })
+        {
+          page: options[:page],
+          limit: options[:limit],
+          createdBefore: options[:createdBefore],
+          createdAfter: options[:createdAfter],
+          sort: options[:sort]
+        }.delete_if { |key, value| value.nil? }
+      end
+    end
+  end
+end

data/lib/wing/actions/stores.rb

@@ -0,0 +1,24 @@
+module Wing
+  module Actions
+    module Stores
+      def list_stores(options = { page: 1, limit: 20, createdBefore: nil, createdAfter: nil })
+        get("/store", query: prepare_query(options)).parsed_response
+      end
+
+      def create_store(data, options = {})
+        post("/store", data, options).parsed_response
+      end
+
+      private
+
+      def prepare_query(options = { page: 1, limit: 20, createdBefore: nil, createdAfter: nil })
+        {
+          page: options[:page],
+          limit: options[:limit],
+          createdBefore: options[:createdBefore],
+          createdAfter: options[:createdAfter],
+        }.delete_if { |key, value| value.nil? }
+      end
+    end
+  end
+end

data/lib/wing/client.rb

@@ -0,0 +1,78 @@
+require 'httparty'
+require 'wing/actions'
+require 'wing/error'
+
+module Wing
+  class Client
+    include Wing::Actions::Stores
+    include Wing::Actions::Orders
+
+    API_VERSION = "v1".freeze
+    BASE_URL = "https://api.wing.eu/".freeze
+    USER_AGENT = "wing-ruby/#{VERSION}".freeze
+
+    def initialize(api_key: nil, api_secret: nil)
+      @api_key = api_key || Wing::configuration.api_key
+      @api_secret = api_secret || Wing::configuration.api_secret
+    end
+
+    def base_url
+      "#{BASE_URL}#{API_VERSION}"
+    end
+
+    def get(path, options = {})
+      execute(:get, path, options)
+    end
+
+    def post(path, data = {}, options = {})
+      execute(:post, path, options.merge(body: data))
+    end
+
+    private
+
+    attr_reader :api_key, :api_secret
+
+    def execute(method, path, options)
+      begin
+        response = request(method, path, options)
+      rescue *Error::NET_HTTP_ERRORS => err
+        raise ConnectionError.new, err.message
+      end
+
+      case response.code
+      when 200..299
+        response
+      when 400
+        raise BadRequestError.new(response['errorDescription'])
+      when 401
+        raise AuthenticationError.new(response['errorDescription'])
+      when 404
+        raise NotFoundError.new(response['errorDescription'])
+      when 400..499
+        raise ResponseError.new(response['errorDescription'])
+      when 500
+        raise InternalServerError.new(response['errorDescription'])
+      when 500..599
+        raise ServerError.new(response['errorDescription'])
+      end
+    end
+
+    def request(method, path, options)
+      HTTParty.send(method, base_url + path, base_options.merge(options))
+    end
+
+    def base_options
+      {
+        format: :json,
+        headers: {
+          "Accept" => "application/json",
+          "User-Agent" => USER_AGENT
+        },
+        basic_auth: {
+          username: api_key,
+          password: api_secret
+        }
+      }
+    end
+  end
+end

data/lib/wing/configuration.rb

@@ -0,0 +1,11 @@
+module Wing
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :api_secret
+
+    def initialize
+      @api_key = nil
+      @api_secret = nil
+    end
+  end
+end

data/lib/wing/error.rb

@@ -0,0 +1,42 @@
+module Wing
+  class Error < StandardError
+    NET_HTTP_ERRORS = [
+      EOFError,
+      Errno::ECONNABORTED,
+      Errno::ECONNREFUSED,
+      Errno::ECONNRESET,
+      Errno::EHOSTUNREACH,
+      Errno::EINVAL,
+      Errno::ENETUNREACH,
+      Net::HTTPBadResponse,
+      Net::HTTPHeaderSyntaxError,
+      Net::ProtocolError,
+      Net::OpenTimeout,
+      Net::ReadTimeout,
+      SocketError,
+      Zlib::GzipFile::Error,
+      OpenSSL::SSL::SSLError
+    ]
+  end
+
+  # Raised on errors in the 400-499 range
+  class ResponseError < Error; end
+
+  # Raised when the API returns a 400 HTTP status code
+  class BadRequestError < ResponseError; end
+
+  # Raised when the API returns a 401 HTTP status code
+  class AuthenticationError < ResponseError; end
+
+  # Raised when the API returns a 404 HTTP status code
+  class NotFoundError < ResponseError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < Error; end
+
+  # Raised when the API returns a 500 HTTP status code
+  class InternalServerError < ServerError; end
+
+  # Raised when we can't establish a connection to the API or if reading the reponse times out
+  class ConnectionError < Error; end
+end

data/lib/wing/version.rb

@@ -0,0 +1,3 @@
+module Wing
+  VERSION = "0.1.1"
+end

data/wing.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/wing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wing.rb"
+  spec.version       = Wing::VERSION
+  spec.authors       = ["Kevin Chavanne"]
+  spec.email         = ["kevin.chavanne@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for wing API}
+  spec.description   = %q{This gem is a wrapper on Wing API v2, that offers shipping services (https://www.wing.eu). }
+  spec.homepage      = "https://www.github.com/wedressfair/wing-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://www.github.com/wedressfair/wing-ruby"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rake", "~> 12"
+  spec.add_development_dependency "webmock", "~> 3"
+  spec.add_runtime_dependency "httparty", "~> 0.16.2"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: wing.rb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kevin Chavanne
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+description: 'This gem is a wrapper on Wing API v2, that offers shipping services
+  (https://www.wing.eu). '
+email:
+- kevin.chavanne@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wing.rb
+- lib/wing/actions.rb
+- lib/wing/actions/orders.rb
+- lib/wing/actions/stores.rb
+- lib/wing/client.rb
+- lib/wing/configuration.rb
+- lib/wing/error.rb
+- lib/wing/version.rb
+- wing-ruby-0.1.0.gem
+- wing.gemspec
+homepage: https://www.github.com/wedressfair/wing-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/wedressfair/wing-ruby
+  source_code_uri: https://www.github.com/wedressfair/wing-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for wing API
+test_files: []