carrierbot_api 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ae635e5b60396c6231e800ee2cabe3a843cbc3d0dfa3b7813d461d21e1c4449
+  data.tar.gz: ff7879ded0c91b72bd17d85a271a359ea29d607a62f25a4b4a2a1d8d0a401fe1
+SHA512:
+  metadata.gz: 6face818d25fc426a22d618a7870f31cae20b20b6a8ccb5c0296f7ebe838eab9bcbe26689e329667e4aff0a39f9d06674de1f864a47acfee09e57c181cb58467
+  data.tar.gz: 3f74e0091b41d14d918c5b0e85d2ce8e9ade22d1998411eb05b9dd6946e56d0770c5073ce7c6d6649660439d3abaf635e9829b7c1ee8f9b2354ed1746ebe80d3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+carrierbot_api-0.1.0.gem

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at storkyd@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    carrierbot_api (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.1)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  carrierbot_api!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.6

data/README.md

@@ -0,0 +1,57 @@
+# CarrierBotAPI
+
+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/carrierbot_api`. 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 'carrierbot_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carrierbot_api
+
+## Usage
+
+A `configuration.yml` file is required in your `/config` directory
+```
+default:
+  carrierbot_origin_country: AU
+  carrierbot_origin_postal_code: 6000
+  carrierbot_origin_province: WA
+  carrierbot_origin_city: Perth
+  carrierbot_origin_name: 
+  carrierbot_origin_address1: 
+  carrierbot_origin_address2: 
+  carrierbot_origin_address3: 
+  carrierbot_origin_phone: 
+  carrierbot_origin_fax: 
+  carrierbot_origin_email: 
+  carrierbot_origin_address_type: 
+  carrierbot_origin_company_name: Seshbot
+  carrierbot_vendor: BrewKeeper
+  carrierbot_fulfillment_service: manual
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/carrierbot_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the CarrierbotRates project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/carrierbot_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "carrierbot_api"
+
+# 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/carrierbot_rates.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "carrierbot_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "carrierbot_api"
+  spec.version       = CarrierBotAPI::VERSION
+  spec.authors       = ["Shaun"]
+  spec.email         = ["shaun@brewkeeper.com.au"]
+
+  spec.summary       = %q{Connect to CarrierBot API}
+  spec.homepage      = "https://gitlab.com/brewkeeper/carrierbot_api"
+
+  # 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://gitlab.com/brewkeeper/carrierbot_api"
+    spec.metadata["changelog_uri"] = "https://gitlab.com/brewkeeper/carrierbot_api/-/blob/master/CHANGELOG.md"
+  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", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/carrierbot_api.rb

@@ -0,0 +1,7 @@
+require "carrierbot_api/version"
+
+require 'carrierbot_api/configuration'
+require 'carrierbot_api/address'
+require 'carrierbot_api/item'
+require 'carrierbot_api/fulfillment'
+require 'carrierbot_api/rates_request'

data/lib/carrierbot_api/address.rb

@@ -0,0 +1,30 @@
+module CarrierBotAPI
+  class Address
+    attr_accessor :country, :postal_code, :province, :city, :name, :address1, :address2, :address3, :phone, :fax, :email, :address_type, :company_name
+
+    def initialize(data)
+      @country = data[:country]
+      @postal_code = data[:postal_code]
+      @province = data[:province]
+      @city = data[:city]
+      @name = data[:name]
+      @address1 = data[:address1]
+      @address2 = data[:address2]
+      @address3 = data[:address3]
+      @phone = data[:phone]
+      @fax = data[:fax]
+      @email = data[:email]
+      @address_type = data[:address_type]
+      @company_name = data[:company_name]
+    end
+
+    def to_json
+      {
+        'country': self.country, 'postal_code': self.postal_code, 'province': self.province, 'city': self.city, 'name': self.name,
+        'address1': self.address1, 'address2': self.address2, 'address3': self.address3,
+        'phone': self.phone, 'fax': self.fax, 'email': self.email, 'address_type': self.address_type,
+        'company_name': self.company_name
+      }
+    end
+  end
+end # module CarrierBot

data/lib/carrierbot_api/configuration.rb

@@ -0,0 +1,49 @@
+module CarrierBotAPI
+  module Configuration
+    @defaults = {}
+    @config = nil
+
+    class << self
+      def load(options={})
+        filename = options[:file] || File.join(Rails.root, 'config', 'configuration.yml')
+        env = options[:env] || Rails.env
+
+        @config = @defaults.dup
+        if File.file?(filename)
+          @config.merge!(load_from_yaml(filename, env))
+        end
+        @config
+      end
+
+      def [](name)
+        load unless @config
+        @config[name]
+      end
+
+      private
+
+      def load_from_yaml(filename, env)
+        yaml = nil
+        begin
+          yaml = YAML::load(ERB.new(File.read(filename)).result)
+        rescue ArgumentError
+          abort "could not load YAML file #{filename}"
+        rescue SyntaxError => e
+          abort "could not load YAML file #{filename} - syntax error:\n#{e.message}"
+        end
+        conf = {}
+        if yaml.is_a?(Hash)
+          if yaml['default']
+            conf.merge!(yaml['default'])
+          end
+          if yaml[env]
+            conf.merge!(yaml[env])
+          end
+        else
+          abort "could not load YAML configuration #{filename} - unexpected formatting"
+        end
+        conf
+      end
+    end # class methods
+  end # module Configuration
+end

data/lib/carrierbot_api/fulfillment.rb

@@ -0,0 +1,27 @@
+module CarrierBotAPI
+  class Fulfillment
+    attr_reader :ordered_at, :fulfilled_at, :total_price, :service_code, :order_id, :fulfillment_id, :items
+
+    def initialize(data)
+      @ordered_at = data[:ordered_at]
+      @fulfilled_at = data[:fulfilled_at]
+      @total_price = data[:total_price]
+      @service_code = data[:service_code]
+      @order_id = data[:order_id]
+      @fulfillment_id = data[:fulfillment_id]
+      @items = data[:items]
+    end
+
+    def to_json
+      {
+        'ordered_at': self.ordered_at,
+        'fulfilled_at': self.fulfilled_at,
+        'total_price': self.total_price,
+        'service_code': self.service_code,
+        'order_id': self.order_id,
+        'fulfillment_id': self.fulfillment_id,
+        'items': self.items.map(&:to_json)
+      }
+    end
+  end
+end # module CarrierBotAPI

data/lib/carrierbot_api/item.rb

@@ -0,0 +1,37 @@
+module CarrierBotAPI
+  class Item
+    attr_reader :name, :sku, :quantity, :grams, :price, :vendor, :requires_shipping, :taxable, :fulfillment_service, :properties, :product_id, :variant_id
+
+    def initialize(data)
+      @name = data[:name]
+      @sku = data[:sku]
+      @quantity = data[:quantity]
+      @grams = data[:grams]
+      @price = data[:price]
+      @vendor = data[:vendor] || CarrierBotAPI::Configuration['carrierbot_vendor']
+      @requires_shipping = data[:requires_shipping]
+      @taxable = data[:taxable]
+      @fulfillment_service = data[:fulfillment_service] || CarrierBotAPI::Configuration['carrierbot_fulfillment_service'] || 'manual'
+      @properties = data[:properties]
+      @product_id = data[:product_id]
+      @variant_id = data[:variant_id]
+    end
+
+    def to_json
+      {
+        'name': self.name,
+        'sku': self.sku,
+        'quantity': self.quantity,
+        'grams': self.grams,
+        'price': self.price,
+        'vendor': self.vendor,
+        'requires_shipping': self.requires_shipping,
+        'taxable': self.taxable,
+        'fulfillment_service': self.fulfillment_service,
+        'properties': self.properties,
+        'product_id': self.product_id,
+        'variant_id': self.variant_id
+      }
+    end
+  end
+end # module CarrierBotAPI

data/lib/carrierbot_api/rates_request.rb

@@ -0,0 +1,59 @@
+module CarrierBotAPI
+  class RatesRequest
+    attr_accessor :url
+
+    def initialize(url = nil)
+      @url = url || Setting.current&.carrier_service_url
+
+      origin_country = CarrierBotAPI::Configuration['carrierbot_origin_country']
+      origin_postal_code = CarrierBotAPI::Configuration['carrierbot_origin_postal_code']
+      origin_province = CarrierBotAPI::Configuration['carrierbot_origin_province']
+      origin_city = CarrierBotAPI::Configuration['carrierbot_origin_city']
+      origin_name = CarrierBotAPI::Configuration['carrierbot_origin_name']
+      origin_address1 = CarrierBotAPI::Configuration['carrierbot_origin_address1']
+      origin_address2 = CarrierBotAPI::Configuration['carrierbot_origin_address2']
+      origin_address3 = CarrierBotAPI::Configuration['carrierbot_origin_address3']
+      origin_phone = CarrierBotAPI::Configuration['carrierbot_origin_phone']
+      origin_fax = CarrierBotAPI::Configuration['carrierbot_origin_fax']
+      origin_email = CarrierBotAPI::Configuration['carrierbot_origin_email']
+      origin_address_type = CarrierBotAPI::Configuration['carrierbot_origin_address_type']
+      origin_company_name = CarrierBotAPI::Configuration['carrierbot_origin_company_name']
+
+      @origin = Address.new(
+        country: origin_country,
+        postal_code: origin_postal_code,
+        province: origin_province,
+        city: origin_city,
+        name: origin_name,
+        address1: origin_address1,
+        address2: origin_address2,
+        address3: origin_address3,
+        phone: origin_phone,
+        fax: origin_fax,
+        email: origin_email,
+        address_type: origin_address_type,
+        company_name: origin_company_name)
+    end
+
+    def get(destination:, items: [], fulfillments: [])
+      conn = Faraday.new(url: @url)
+
+      request = {
+        'rate': {
+          'origin': @origin.to_json,
+          'destination': destination.to_json,
+          'items': items.map(&:to_json),
+          'fulfillments': fulfillments.map(&:to_json),
+          'currency': 'JPY', 'locale': 'en'
+        }
+      }
+
+      response = conn.post '/api/v1/requests', request
+      raise "could not retrieve shipping rates - #{response.reason_phrase}\nrequest: #{request}" \
+        unless response.success?
+
+      rates = JSON.parse(response.body)['rates']
+      rates
+    end
+  end
+end

data/lib/carrierbot_api/version.rb

@@ -0,0 +1,3 @@
+module CarrierBotAPI
+  VERSION = "0.3.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: carrierbot_api
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Shaun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- shaun@brewkeeper.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- carrierbot_rates.gemspec
+- lib/carrierbot_api.rb
+- lib/carrierbot_api/.DS_Store
+- lib/carrierbot_api/address.rb
+- lib/carrierbot_api/configuration.rb
+- lib/carrierbot_api/fulfillment.rb
+- lib/carrierbot_api/item.rb
+- lib/carrierbot_api/rates_request.rb
+- lib/carrierbot_api/version.rb
+homepage: https://gitlab.com/brewkeeper/carrierbot_api
+licenses: []
+metadata:
+  homepage_uri: https://gitlab.com/brewkeeper/carrierbot_api
+  source_code_uri: https://gitlab.com/brewkeeper/carrierbot_api
+  changelog_uri: https://gitlab.com/brewkeeper/carrierbot_api/-/blob/master/CHANGELOG.md
+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.8
+signing_key: 
+specification_version: 4
+summary: Connect to CarrierBot API
+test_files: []