eship-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54d6d193460695dd001df588a5c09e4d6e63fcc8258c4b76cb87addbe0a11e56
+  data.tar.gz: 92168544d88559de922412ab3755c4ff0781d37ab8bc4200fae6cc40e145656a
+SHA512:
+  metadata.gz: 9cbdd3b6a828b8fa8e4092ad6358422296027c6c502a2fae2bcda4534f7b85bcb02db0ee4aaa5afcf1d58a013324e9092bfbff85213a4bd5d9c95acc43e6087b
+  data.tar.gz: b60bcfc05908a936908f13effa2e77dc46bed1973d96cb08d6bc9169fbdb81d94538818b2fb20e2d6a6750ef3e013cbb81610665446fba082972d05d96a7e46d

data/ bitbucket-pipelines.yml

@@ -0,0 +1,19 @@
+# This is a sample build configuration for Ruby.
+# Check our guides at https://confluence.atlassian.com/x/8r-5Mw for more examples.
+# Only use spaces to indent your .yml configuration.
+# -----
+# You can specify a custom docker image from Docker Hub as your build environment.
+image: ruby:2.5.1
+
+pipelines:
+  default:
+    - step:
+        caches:
+          - bundler
+        script: # Modify the commands below to build your repository.
+          - bundle install
+          - rspec
+
+definitions:
+  caches:
+    bundler: ./vendor

data/.gitignore

@@ -0,0 +1,64 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# npm
+node_modules
+
+# rspec failure tracking
+.rspec_status
+
+.Ds_store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in eship-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    eship-ruby (0.1.0)
+      httparty (~> 0.16.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    app_version_tasks (0.2.5)
+      git (~> 1.3)
+    ast (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    git (1.6.0)
+      rchardet (~> 1.8)
+    hashdiff (1.0.1)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    jaro_winkler (1.5.4)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    multi_xml (0.6.0)
+    parallel (1.19.1)
+    parser (2.7.1.1)
+      ast (~> 2.4.0)
+    public_suffix (4.0.4)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rchardet (1.8.0)
+    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.1)
+      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)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-airbnb (3.0.2)
+      rubocop (~> 0.76.0)
+      rubocop-performance (~> 1.5.0)
+      rubocop-rails (~> 2.3.2)
+      rubocop-rspec (~> 1.30.0)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    rubocop-rails (2.3.2)
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    rubocop-rspec (1.30.1)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    unicode-display_width (1.6.1)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  app_version_tasks
+  bundler (~> 1.17)
+  eship-ruby!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop-airbnb (~> 3.0)
+  rubocop-rspec (~> 1.30)
+  simplecov (~> 0.17)
+  webmock (~> 3.7)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,37 @@
+# Eship::Ruby
+
+Eship-ruby es una gema para interactuar con la API de segmail proporciona a través del servicio de paqueterías Eship. Con esta gema es posible generar una orden en el `dashboard` del servicio y continuar el proceso manualmente sin tener que ingresar los datos del remitente y el destinatario de manera manual.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eship-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eship-ruby
+
+## Usage
+During the setup configuration you must add your eship api-key and the base URI.
+```sh
+    Eship.config do |config|
+        config.base_uri = 'https://app.myeship.co/API/'
+        config.eship_key = 'Randomkey12x'
+    end
+```
+### making querys
+Eship-ruby expects the payload as described in the eship documentation https://myeship.co/docs/
+```sh
+response = Eship.post_quotation(payload)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/eship-ruby.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'app_version_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+spec = Gem::Specification.find_by_name 'app_version_tasks'
+load "#{spec.gem_dir}/lib/tasks/app_version_tasks.rake"
+AppVersionTasks.configure do |config|
+  config.application_name = 'Eship-ruby'
+  config.version_file_path = File.join('lib', 'eship', 'version.rb')
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'eship/ruby'
+
+# 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/bitbucket-pipelines.yml

@@ -0,0 +1,19 @@
+# This is a sample build configuration for Ruby.
+# Check our guides at https://confluence.atlassian.com/x/8r-5Mw for more examples.
+# Only use spaces to indent your .yml configuration.
+# -----
+# You can specify a custom docker image from Docker Hub as your build environment.
+image: ruby:2.5.1
+
+pipelines:
+  default:
+    - step:
+        caches:
+          - bundler
+        script: # Modify the commands below to build your repository.
+          - bundle install
+          - rspec
+
+definitions:
+  caches:
+    bundler: ./vendor

data/eship-ruby.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eship/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'eship-ruby'
+  spec.version       = Eship::VERSION
+  spec.authors       = ['Yellowme']
+  spec.email         = ['hola@yellowme.mx']
+
+  spec.summary       = 'Eship-ruby provides a layer to interact with the Segmail API throug the Eship parcels service'
+  spec.description   = 'with Eship-ruby you can generate an order in the `dashboard` without the need to enter all the data manually.'
+  spec.homepage      = 'https://yellowme.mx'
+
+  # 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(__dir__)) 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_dependency 'httparty', '~> 0.16.0'
+
+  spec.add_development_dependency 'app_version_tasks'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop-airbnb', '~> 3.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.30'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+  spec.add_development_dependency 'webmock', '~> 3.7'
+end

data/lib/.rubocop.yml

@@ -0,0 +1 @@
+require: rubocop-rspec

data/lib/.rubocop_airbnb.yml

@@ -0,0 +1,2 @@
+require:
+  - rubocop-airbnb

data/lib/eship.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'eship/version.rb'
+require 'eship/api_client.rb'
+require 'eship/endpoints.rb'
+require 'eship/quotation.rb'
+
+module Eship
+  def self.config
+    yield self
+  end
+
+  def self.version
+    @version
+  end
+
+  def self.base_uri
+    @base_uri
+  end
+
+  def self.base_uri=(base_uri)
+    @base_uri = base_uri
+  end
+
+  def self.eship_key
+    @eship_key
+  end
+
+  def self.eship_key=(eship_key)
+    @eship_key = eship_key
+  end
+end

data/lib/eship/api_client.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require 'httparty'
+
+module Eship
+  module ApiClient
+    def self.default_headers
+      {
+        "content-type" => 'application/json',
+        ImmutableKey.new("api-key") => Eship.eship_key 
+      }
+    end
+
+    def self.post(path:, body: {}, headers: {})
+      path = "#{Eship.base_uri}#{path}"
+      headers = headers.merge(ApiClient.default_headers)
+      response = HTTParty.post(path, body: body.to_json, headers: headers)
+      JSON.parse(response.body)
+    end
+
+    #Monkey patch to avoid headers capitalization https://jatindhankhar.in/blog/custom-http-header-and-ruby-standard-library/
+    class ImmutableKey < String 
+      def capitalize 
+        self 
+      end
+
+      def to_s
+        self 
+       end 
+
+       alias_method :to_str, :to_s
+    end
+  end
+end

data/lib/eship/endpoints.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Eship
+  module Endpoints
+    POST_QUOTATION = 'quotation'
+  end
+end

data/lib/eship/quotation.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Eship
+  def self.post_quotation(payload)
+    response = ApiClient.post(
+      path: Endpoints::POST_QUOTATION,
+      body: payload
+    )
+  end
+end

data/lib/eship/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Eship
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: eship-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yellowme
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: app_version_tasks
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: rubocop-airbnb
+  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: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: with Eship-ruby you can generate an order in the `dashboard` without
+  the need to enter all the data manually.
+email:
+- hola@yellowme.mx
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- " bitbucket-pipelines.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bitbucket-pipelines.yml
+- eship-ruby.gemspec
+- lib/.rubocop.yml
+- lib/.rubocop_airbnb.yml
+- lib/eship.rb
+- lib/eship/api_client.rb
+- lib/eship/endpoints.rb
+- lib/eship/quotation.rb
+- lib/eship/version.rb
+homepage: https://yellowme.mx
+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.6
+signing_key: 
+specification_version: 4
+summary: Eship-ruby provides a layer to interact with the Segmail API throug the Eship
+  parcels service
+test_files: []