carriage 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81c8dfff264cd4dea5094c483c609afccc1fca19e9b91da6e7bca55983f9cfcb
-  data.tar.gz: be7d270310b5a22abde524ff6e22934f4556460f2e686ae22270a91c53195a4e
+  metadata.gz: e0a6df75b802ea7014df9978ab2d1aedb81a00328c2103ce83afc666822b7e15
+  data.tar.gz: 92e0e907d018c4fdd852c1ada76f671bd5e9ac328aaaf6a2f4684293211eb289
 SHA512:
-  metadata.gz: '0000209ec66433e65ccb757f72ac4cf37e8239ade04c5d4cec71d98b7524b1c738a87f829c8f7c28bcc6c12ac4a5b119906297c0765f41ec5e111ee847cdbb5a'
-  data.tar.gz: ebd344788003ca269bdfb07c732467cc4f5666f328bfd91d2c4d3756ee6a63013a4f6d24d9b0b1dc6ab222a1d022bc8f3222de69d2222f1e7b6dc08eb821a3e5
+  metadata.gz: ed3913d1b34914f84aa6c6e61765d43cfc927d84ea20a44c05a92d3da98423f4f768e12e9a65c72badf7a2b5c869e265b0d8530cf7f629511db4fa00d7506f81
+  data.tar.gz: 559346f9ea611a91d80afdd30f0bb6d77e434ed567a889417179a4958edc6899c0337e731a495cc09aca51df94444ba0b08e8b9b43bba48c8b91bc67755931a0

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.idea/
+.rakeTasks
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,19 @@
+---
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=60a3a7f0557745522235c43c9281570385a1c9d566a40946f91bb156e4ec4df0
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+before_install: gem install bundler -v 2.1.2
+script:
+  - "bundle install"
+  - "bundle exec rake test"
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [1.2.1]
+- Rollback some changes in gemspec
+
+## [1.2.0]
+### Breaking change
+- hash now accepts :id key, but doesn't accept :OfferListingId anymore.
+
+### Added
+- test to verify that quantity could be set
+
+## [1.1.1]
+### Added
+- Project website
+
+## [1.1.0]
+### Added
+- Project logo
+
+### Changed
+- Improve gem description
+- Clean-up Gemfile
+- Simplified Locale error handling
+- Refactoring 
+
+## [1.0.0]
+
+- Finalize documentation
+- Release 1 version to show completeness of api
+
+## [0.3.0]
+
+### Added
+- Support for Amazon locales
+- Support for OfferListingId
+
+## [0.2.0]
+### Added
+- Set default quantity for a product
+- Write down locales and respective hosts associated with them
+
+### Changed
+- Using `URI.encode_www_form` to build URL parameters
+- `AWSAccessKeyId` is not a required argument
+
+## [0.1.0]
+First public version, only focused on supporting one region - US.

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 sk@skylup.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Stanislav (Stas) Katkov
+
+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,87 @@
+[![Gem Version](https://badge.fury.io/rb/carriage.svg)](https://badge.fury.io/rb/carriage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/79ddcbeb02fe9447cd0d/maintainability)](https://codeclimate.com/github/skatkov/carriage/maintainability)
+[![Build Status](https://travis-ci.org/skatkov/carriage.svg?branch=master)](https://travis-ci.org/skatkov/carriage)
+
+# Carriage
+<p align="center">
+  <img src="./vendor/logo.jpg" alt="Carriage project logo" width="400">
+</p>
+
+Carriage is a Ruby micro-wrapper to [Amazon's Cart Form](https://webservices.amazon.com/paapi5/documentation/add-to-cart-form.html) functionality. Gem helps add any number of items to customer's shopping cart and direct him to Amazon website to complete order. 
+
+To use this gem, you will eventually require Amazon's **AssociateTag**, so consider to [register first](https://webservices.amazon.com/paapi5/documentation/register-for-pa-api.html) with Amazon Associate program and become more familiar with it.
+
+Programmatic access to product data is out of scope for this gem, but I recommend to use [vacuum gem](https://github.com/hakanensari/vacuum) if there is such a need.
+
+[Battle tested at aShop](https://www.ashop.co/?utm_source=carriage-gem)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'carriage'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install carriage
+
+## Usage
+
+A lot of examples could be found [in tests](https://github.com/skatkov/carriage/blob/master/test/carriage_test.rb)
+
+There are basically two ways to use this gem `bare metal` and with `builder`. Let's start off with baremetal:
+
+### Bare metal
+```
+Carriage.call(:us, {
+  AssociateTag:'tag', 
+  "OfferListingId.1": "B00WR23X5I", 
+  "Quantity.1": 1 
+ }
+)
+```
+The only thing it will validate, is a presence of locale. All other parameters will be converted by `URI.encode_www_form` without any verification. Be carefull!
+
+### Builder
+Library also offers a simpler interface that tries to valide data with convinince methods on top.
+
+```
+items = [
+ {Id: '123123'}.
+ {ASIN: '1231234', quantity: 2}
+]
+
+Carriage.build(items, tag: 'my_attribution_tag', locale: :uk)
+```
+
+* Every item should be a hash, with `ASIN` or `ID` (short for `OfferListingId`) key provided. All keys are _case insensitive_.
+* By default quantity is 1, feel free to rewrite that. 
+* `Carriage.build` also requires `:tag` attribute (short for `AssociateTag`)
+*  Defaults to `locale: :us`, if no other locale was provided.
+
+### Locale
+All locale are based on a two letter country codes - **ISO 3166-1 alpha-2**. Here is an exact mapping:
+
+https://github.com/skatkov/carriage/blob/master/lib/carriage/locale.rb#L7-L23
+
+## Getting help
+
+* Ask specific questions about the API on the [Amazon forum](https://forums.aws.amazon.com/forum.jspa?forumID=9).
+* Report bugs and discuss potential features in [GitHub issues](https://github.com/skatkov/carriage/issues).
+
+## Credits
+Logo was done by [Max Kazmin](https://dribbble.com/maxpainter)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Carriage project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/skatkov/carriage/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/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal

data/bin/console

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

@@ -0,0 +1,32 @@
+require_relative 'lib/carriage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carriage"
+  spec.version       = Carriage::VERSION
+  spec.authors       = ["Stanislav (Stas) Katkov"]
+  spec.email         = ["sk@skylup.com"]
+
+  spec.summary       = "Carriage is a Ruby micro-wrapper to Amazon's Cart Form functionality (part of Product Advertising API v5.0)"
+  spec.description   = "Gem helps add any number of items to customer's shopping cart and direct him to Amazon website to complete order."
+  spec.homepage      = "https://skatkov.github.io/carriage/"
+  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://github.com/skatkov/carriage"
+  spec.metadata["changelog_uri"] = "https://github.com/skatkov/carriage/blob/master/CHANGELOG.md"
+
+  # 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 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'm'
+end

data/docs/.gitkeep

@@ -0,0 +1 @@
+ 

data/docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-tactile

data/lib/carriage.rb

@@ -0,0 +1,14 @@
+require 'carriage/version'
+require 'carriage/locale'
+require 'carriage/url'
+require 'carriage/builder'
+require 'forwardable'
+
+module Carriage
+  class << self
+    extend Forwardable
+
+    def_delegator 'Carriage::Url', :call
+    def_delegator 'Carriage::Builder', :call, :build
+  end
+end

data/lib/carriage/builder.rb

@@ -0,0 +1,39 @@
+module Carriage
+  class Builder
+    class << self
+      def call(items, tag:, key_id: nil, locale: :us)
+        params = {}
+
+        wrap(items).each_with_index do |obj, index|
+          item = obj.transform_keys(&:upcase)
+
+          if item[:ASIN]
+            params[:"ASIN.#{index + 1}"] = item[:ASIN]
+          elsif item[:ID]
+            params[:"OfferListingId.#{index + 1}"] = item[:ID]
+          else
+            next
+          end
+          params[:"Quantity.#{index + 1}"] = item.fetch(:QUANTITY, 1)
+        end
+
+        params[:AssociateTag] = tag
+        params[:AWSAccessKeyId] = key_id unless (key_id.nil? || key_id.empty?)
+
+        Carriage.call(locale, params)
+      end
+
+      private
+
+      def wrap(object)
+        if object.nil?
+          []
+        elsif object.respond_to?(:to_ary)
+          object.to_ary || [object]
+        else
+          [object]
+        end
+      end
+    end
+  end
+end

data/lib/carriage/locale.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Carriage
+  class Locale
+    class NotFound < KeyError; end
+
+    HOSTS = {
+        au: 'https://www.amazon.com.au/gp/aws/cart/add.html',
+        br: 'https://www.amazon.com.br/gp/aws/cart/add.html',
+        ca: 'https://www.amazon.ca/gp/aws/cart/add.html',
+        fr: 'https://www.amazon.fr/gp/aws/cart/add.html',
+        de: 'https://www.amazon.de/gp/aws/cart/add.html',
+        in: 'https://www.amazon.in/gp/aws/cart/add.html',
+        it: 'https://www.amazon.it/gp/aws/cart/add.html',
+        jp: 'https://www.amazon.co.jp/gp/aws/cart/add.html',
+        mx: 'https://www.amazon.com.mx/gp/aws/cart/add.html',
+        sg: 'https://www.amazon.sg/gp/aws/cart/add.html',
+        es: 'https://www.amazon.es/gp/aws/cart/add.html',
+        tr: 'https://www.amazon.com.tr/gp/aws/cart/add.html',
+        ae: 'https://www.amazon.ae/gp/aws/cart/add.html',
+        uk: 'https://www.amazon.co.uk/gp/aws/cart/add.html',
+        us: 'https://www.amazon.com/gp/aws/cart/add.html'
+    }.freeze
+
+    private_constant :HOSTS
+
+    attr_reader :host
+
+    def initialize(locale)
+      @host = HOSTS.fetch(locale.to_sym.downcase) do |value|
+        raise NotFound, "Locale not found: :#{value}"
+      end
+    end
+  end
+end