searates 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ccfa3f04be9a5e54658770d3edfd8d0301c5ec6ccfd05322c1b8f56772c9da51
+  data.tar.gz: 215848dfda17abf1475e84beb4d0ef93b3453408d9d8f88e4822c4dd479f7a5b
+SHA512:
+  metadata.gz: '08e1bd4401b4dabaf40ce442c0f7739f09eb5b0bdf18a8f325fee881d9d5a758896d521d571048c17ea94a200a1f29db63637f97b37da64cee0f9cc84188886c'
+  data.tar.gz: 703633c976bdffaeaa1c822604731bdd0863adf6273e368ce67eb0d93dff153f5f082a42136fd1791c62efa36fc57a249440a38ef20ed2f7b40c6e075f2a1627

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in searates.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    searates (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  searates!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 André Galatti
+
+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,94 @@
+# SeaRates
+
+Ruby gem to make requests to SeaRates REST API in a simple and easy way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'searates'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install searates
+
+## Usage
+
+Run the Generator:
+
+    $ rails g searates:install
+
+
+Place your API Key as an environment variable at your server or replace the ENV value in the initializer `initializers/searates.rb`
+
+```ruby
+Searates.configure do |config|
+  config.api_key = ENV['SEARATES_API_KEY']
+  #config.api_key = 'XXXXXXXXXXXXXXXX'
+end
+```
+
+### Logistics Explorer - FCL Rates
+
+To make requests, simple call the API you want and store the return in a variable. e.g.
+```ruby
+response = Searates::API::LogisticsExplorer.get_fcl_rates(lat_from, lng_from, lat_to, lng_to)
+```
+
+you can also pass *true* after the lng_to value if you also want the route info.
+
+### Logistics Explorer - LCL Rates
+
+- Weight of cargo in *kg*
+- Volume of cargo in *CBM*
+
+```ruby
+response = Searates::API::LogisticsExplorer.get_lcl_rates(lat_from, lng_from, lat_to, lng_to, volume, weight)
+```
+
+### Logistics Explorer - Sea Route
+
+```ruby
+response = Searates::API::LogisticsExplorer.get_sea_route(lat_from, lng_from, lat_to, lng_to)
+```
+
+### Logistics Explorer - Air Rates
+
+- Weight of cargo in *tons*
+
+```ruby
+response = Searates::API::LogisticsExplorer.get_air_rates(lat_from, lng_from, lat_to, lng_to, weight)
+```
+
+### Logistics Explorer - Rail Rates
+
+```ruby
+response = Searates::API::LogisticsExplorer.get_rail_rates(lat_from, lng_from, lat_to, lng_to)
+```
+
+### Logistics Explorer - Road Rates
+
+- Weight of cargo in *kg*
+- Volume of cargo in *CBM*
+- Type of shipment. The available values for this parameter are: `LTL | FTL | CONTAINER` *(optional) Default value: CONTAINER*
+- Container type. The available values for this parameter are: `20st | 40st | 40hq | 20ref | 40ref` *(optional) Default value: 20st*
+
+```ruby
+response = Searates::API::LogisticsExplorer.get_road_rates(lat_from, lng_from, lat_to, lng_to, volume, weight, type, container)
+```
+
+## For more information, please visit the [official  API documentation](https://www.searates.com/reference/platform-api/)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andre-lgf/searates.
+
+## 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 "searates"
+
+# 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/generators/searates/install_generator.rb

@@ -0,0 +1,13 @@
+module Searates
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Creates a SeaRates initializer file in your application.'
+
+      def copy_initializer
+        template 'searates.rb', 'config/initializers/searates.rb'
+      end
+    end
+  end
+end

data/lib/generators/templates/searates.rb

@@ -0,0 +1,3 @@
+Searates.configure do |config|
+  config.api_key = ENV['SEARATES_API_KEY']
+end

data/lib/searates.rb

@@ -0,0 +1,22 @@
+require "searates/version"
+require 'searates/configuration'
+require 'searates/errors'
+require 'searates/api'
+
+module Searates
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/searates/api.rb

@@ -0,0 +1,2 @@
+require 'searates/api/logistics_explorer'
+require 'open-uri'

data/lib/searates/api/logistics_explorer.rb

@@ -0,0 +1,50 @@
+module Searates
+  module API
+    class LogisticsExplorer
+      BASE_URL = 'https://sirius.searates.com/port/api-'
+      def self.get_fcl_rates(lat_from, long_from, lat_to, long_to, route_info=false)
+        [lat_from, long_from, lat_to, long_to].each{|param| raise Searates::Errors::API::MissingParameters, "Missing parameter: #{param}" unless param}
+        request_url = "#{BASE_URL}fcl?apiKey=#{Searates.configuration.api_key}&lat_from=#{lat_from}&lng_from=#{long_from}&lat_to=#{lat_to}&lng_to=#{long_to}&route_info=#{route_info}"
+        response = JSON.parse(URI.open(request_url).read)
+      end
+      
+      def self.get_lcl_rates(lat_from, long_from, lat_to, long_to, weight, volume)
+        [lat_from, long_from, lat_to, long_to, weight, volume].each{|param| raise Searates::Errors::API::MissingParameters, "Missing parameter: #{param}" unless param}
+        request_url = "#{BASE_URL}lcl?apiKey=#{Searates.configuration.api_key}&lat_from=#{lat_from}&lng_from=#{long_from}&lat_to=#{lat_to}&lng_to=#{long_to}&weight=#{weight}&volume=#{volume}"
+        response = JSON.parse(URI.open(request_url).read)
+      end
+      
+      def self.get_sea_route(lat_from, long_from, lat_to, long_to)
+        [lat_from, long_from, lat_to, long_to].each{|param| raise Searates::Errors::API::MissingParameters, "Missing parameter: #{param}" unless param}
+        request_url = "#{BASE_URL}path?apiKey=#{Searates.configuration.api_key}&lat_from=#{lat_from}&lng_from=#{long_from}&lat_to=#{lat_to}&lng_to=#{long_to}"
+        response = JSON.parse(URI.open(request_url).read)
+      end
+      
+      def self.get_air_rates(lat_from, long_from, lat_to, long_to, weight)
+        [lat_from, long_from, lat_to, long_to, weight].each{|param| raise Searates::Errors::API::MissingParameters, "Missing parameter: #{param}" unless param}
+        request_url = "#{BASE_URL}air?apiKey=#{Searates.configuration.api_key}&lat_from=#{lat_from}&lng_from=#{long_from}&lat_to=#{lat_to}&lng_to=#{long_to}&weight=#{weight}"
+        response = JSON.parse(URI.open(request_url).read)
+      end
+      
+      def self.get_rail_rates(lat_from, long_from, lat_to, long_to)
+        [lat_from, long_from, lat_to, long_to].each{|param| raise Searates::Errors::API::MissingParameters, "Missing parameter: #{param}" unless param}
+        request_url = "#{BASE_URL}rail?apiKey=#{Searates.configuration.api_key}&lat_from=#{lat_from}&lng_from=#{long_from}&lat_to=#{lat_to}&lng_to=#{long_to}"
+        response = JSON.parse(URI.open(request_url).read)
+      end
+      
+      def self.get_road_rates(lat_from, long_from, lat_to, long_to, weight, volume, type='CONTAINER', container='20st')
+        [lat_from, long_from, lat_to, long_to, weight, volume, type, container].each{|param| raise Searates::Errors::API::MissingParameters, "Missing parameter: #{param}" unless param}
+        request_url = "#{BASE_URL}air?apiKey=#{Searates.configuration.api_key}&lat_from=#{lat_from}&lng_from=#{long_from}&lat_to=#{lat_to}&lng_to=#{long_to}&weight=#{weight}&volume=#{volume}"
+        if type
+          raise Searates::Errors::API::InvalidParameterValue unless ['FCL', 'LCL', 'CONTAINER'].include? type.upcase
+          request_url += "&type=#{type.upcase}"
+        end
+        if container
+          raise Searates::Errors::API::InvalidParameterValue unless container.downcase =~ /20st|40st|40hq|20ref|40ref/
+          request_url += "&container=#{container.downcase}"
+        end
+        response = JSON.parse(URI.open(request_url).read)
+      end
+    end
+  end
+end

data/lib/searates/configuration.rb

@@ -0,0 +1,14 @@
+module Searates
+  class Configuration    
+    attr_accessor :api_key
+
+    def initialize
+      @api_key ||= nil
+    end
+    
+    def api_key
+      raise Searates::Errors::Configuration, 'SeaRates API Key missing!' unless @api_key
+      @api_key
+    end
+  end
+end

data/lib/searates/errors.rb

@@ -0,0 +1,10 @@
+module Searates
+  module Errors
+    class Configuration < StandardError; end
+    
+    module API
+      class MissingParameters < StandardError; end
+      class InvalidParameterValue < StandardError; end
+    end
+  end
+end

data/lib/searates/version.rb

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

data/searates.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "searates/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "searates"
+  spec.version       = Searates::VERSION
+  spec.authors       = ["André Galatti"]
+  spec.email         = ["andreluisgalatti@hotmail.com"]
+
+  spec.summary       = %q{SeaRates' REST API Consumer}
+  spec.homepage      = "https://github.com/andre-lgf/searates"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/andre-lgf/searates"
+    #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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 "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: searates
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- André Galatti
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-19 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: 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'
+description: 
+email:
+- andreluisgalatti@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/searates/install_generator.rb
+- lib/generators/templates/searates.rb
+- lib/searates.rb
+- lib/searates/api.rb
+- lib/searates/api/logistics_explorer.rb
+- lib/searates/configuration.rb
+- lib/searates/errors.rb
+- lib/searates/version.rb
+- searates.gemspec
+homepage: https://github.com/andre-lgf/searates
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andre-lgf/searates
+  source_code_uri: https://github.com/andre-lgf/searates
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: SeaRates' REST API Consumer
+test_files: []