cordial 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9834a9b273a4f75b86bdb25a525f06a7741f07d9
-  data.tar.gz: f5c9a349b0cbf7d11288315f2dae72f94e2a7880
+SHA256:
+  metadata.gz: 9089db5704b706616ddb2dbb61d3bf9c39ab1d1d913a65010e106392922129fd
+  data.tar.gz: 302c5bd555e14a08724574e49e6b56d50841b3f5fcb1f5d2aa1fa84e44b676fe
 SHA512:
-  metadata.gz: 8e47545046595421b9362b63f6accd536b8770c2101da2b65f700f3d7a0dd239f8c969480075cae940a4ea21d203faf10aabf93ab45753864daf503c00dbf762
-  data.tar.gz: 53bcd80e70a65ac88fc6665c3948fe2d8623828918eb97868ffc6c9bb7c1a3706e21376d449be99f14001af23ae9c63017f1c51fef8ecd1f40e6b6c7eecf4fd3
+  metadata.gz: 3ef85ffef892870a0ca98c312b87f3ab353c17f3921f6a8ae15f62382e00f8c21fa27ba6eb1cf29b84b3b639c41bf5daedbfec286dd7b8c8ccffab4332c3f79a
+  data.tar.gz: 78d3a5ab621cc4674aba5e9b6e927da3a97c2af047ac94b6d6fc3664c237e19eaf9419e897cf2a0e163d9d1fdc4bc462465b05e180dfed05a6de8045902a05c5

data/.gitignore

@@ -12,3 +12,4 @@
 .rspec_status
 
 .env
+.env.test

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,37 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-09-10 16:19:18 -0700 using RuboCop version 0.59.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 7
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 97
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 19
+
+# Offense count: 2
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 7
+
+# Offense count: 3
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/cordial.rb'
+    - 'lib/utils/compact.rb'
+
+# Offense count: 14
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 328

data/Gemfile

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

data/History.md

@@ -0,0 +1,89 @@
+v0.1.10 / 2018-09-07
+====================
+
+  * Bump version
+  * Add Automation templates send endpoint
+  * Bump version
+  * Add Automation templates post endpoint
+
+v0.1.8 / 2018-08-29
+===================
+
+  * Bump Version
+  * Update product create method to manage optional parameters
+
+v0.1.7 / 2018-08-27
+===================
+
+  * Bump Version
+  * Avoid send mcID nil values
+
+v0.1.6 / 2018-08-13
+===================
+
+  * Bump Version
+  * Update unsubscribe method
+  * Add VCR Gem
+
+v0.1.5 / 2018-08-07
+===================
+
+  * Bump Version
+  * Add linkID and mcID in order create method
+
+v0.1.4 / 2018-07-02
+===================
+
+  * Bump version
+  * Add Cordial::Orders find and create
+  * Update product documentation
+
+v0.1.3 / 2018-06-25
+===================
+
+  * Bump gem version
+  * Add more ruby versions to Travis
+  * Add compact Hash method
+
+v0.1.2 / 2018-06-18
+===================
+
+  * Update Version
+  * Add Create Product method
+  * Add Cordial::Products
+  * Add subscribe status to Contacts#create
+  * Add CodeClimate reporter to travis
+  * Use default travis config
+  * bump ruby version
+  * Update rake requirement to ~> 12.3
+  * Use new CodeClimate badges
+  * Add YARDoc to Contacts
+  * Remove unused config attribute api_url
+  * Add badges and more to readme
+
+v0.1.1 / 2018-05-07
+===================
+
+  * Bump to 0.1.1
+  * Add unsubscribe method
+  * Fix Style details
+  * Remove unneeded stuff from gemspec
+  * Add MIT license
+  * Lock dependencies
+  * Lock all dev dependencies
+  * Add simplecov
+  * Add Cordial::Contact.new to create contacts
+  * Move base_uri to the client helper
+  * Configure gem for test suite
+  * Add .env.test
+  * Add Cordial::Contacts
+  * Add Cordial api client w/basic auth
+  * Configure local test environment
+  * Add dotenv
+  * Add ability to configure the gem
+  * Add pry
+  * Depend on httparty
+  * Add .ruby-version
+  * Remove dummy spec
+  * Update gemspec with required information
+  * Initial commit

data/README.md

@@ -1,6 +1,5 @@
 # Cordial
 
-[ ![Codeship Status for MeUndies/cordial](https://app.codeship.com/projects/ecb6fbe0-2a65-0136-d9ce-769c4cc8653c/status?branch=master)](https://app.codeship.com/projects/287555)
 [![Gem Version](https://badge.fury.io/rb/cordial.svg)](https://badge.fury.io/rb/cordial)
 [![Maintainability](https://api.codeclimate.com/v1/badges/a53de2aaf1773c8cfb06/maintainability)](https://codeclimate.com/github/MeUndies/cordial/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/a53de2aaf1773c8cfb06/test_coverage)](https://codeclimate.com/github/MeUndies/cordial/test_coverage)
@@ -37,9 +36,24 @@ Cordial::Contact.create(email: 'hello@world')
 
 ## 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 get started you're going to need to get a Cordial api key.
 
-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).
+After checking out the repo, run `bin/setup` to install dependencies. Then
+update your `.env` files with your api key. 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).
+
+## Tests
+
+Once you've setup your environment you can run the tests with `rake spec`. In
+order to re-record VCR cassettes you'll want to make sure you have the following
+env var set as follows: `VCR=all`.
 
 ## Contributing
 

data/Rakefile

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

data/bin/console

@@ -1,12 +1,12 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "dotenv/load"
-require "cordial"
+require 'bundler/setup'
+require 'dotenv/load'
+require 'cordial'
 
 Cordial.configure do |config|
   config.api_key = ENV['API_KEY']
 end
 
-require "pry"
+require 'pry'
 Pry.start

data/bin/setup

@@ -5,3 +5,4 @@ set -vx
 
 bundle install
 cp -i .env.sample .env
+cp -i .env.sample .env.test

data/cordial.gemspec

@@ -1,32 +1,33 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "cordial/version"
+require 'cordial/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "cordial"
+  spec.name          = 'cordial'
   spec.version       = Cordial::VERSION
-  spec.authors       = ["Andrew Hood"]
-  spec.email         = ["andrewhood125@gmail.com"]
+  spec.authors       = ['Andrew Hood']
+  spec.email         = ['andrewhood125@gmail.com']
 
-  spec.summary       = "Cordial API Client"
-  spec.description   = "Wraps the Cordial REST API for use inside Ruby applications."
-  spec.homepage      = "https://github.com/MeUndies/cordial"
+  spec.summary       = 'Cordial API Client'
+  spec.description   = 'Wraps the Cordial REST API for use inside Ruby applications.'
+  spec.homepage      = 'https://github.com/MeUndies/cordial'
 
   spec.license       = 'MIT'
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "httparty", "~> 0.16"
+  spec.add_dependency 'httparty', '~> 0.16'
+  spec.add_dependency 'hashie', '~> 3.5'
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry", "~> 0.11"
-  spec.add_development_dependency "dotenv", "~> 2.4"
-  spec.add_development_dependency "simplecov", "~> 0.16"
-  spec.add_development_dependency "vcr", "~> 4.0"
-  spec.add_development_dependency "webmock", "~> 3.4.0"
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'dotenv', '~> 2.4'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.59'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'webmock', '~> 3.4.0'
 end

data/lib/cordial/automation_templates.rb

@@ -41,13 +41,13 @@ module Cordial
                     baseAggregation: base_aggregation,
                     message: {
                       headers: {
-                          subject: headers[:subject_email],
-                          fromEmail: headers[:from_email],
-                          replyEmail: headers[:reply_email],
-                          fromDesc: headers[:from_description]
+                        subject: headers[:subject_email],
+                        fromEmail: headers[:from_email],
+                        replyEmail: headers[:reply_email],
+                        fromDesc: headers[:from_description]
                       },
                       content: {
-                          "text/html": content[:text]
+                        "text/html": content[:text]
                       }
                     }
                   }.to_json)

data/lib/cordial/order.rb

@@ -0,0 +1,19 @@
+module Cordial
+  class Order < Hashie::Dash
+    property :orderID
+    property :email, required: -> { cID.nil? }, message: 'email is required if cID is not set.'
+    property :cID, required: -> { email.nil? }, message: 'cID is required if email is not set.'
+    property :linkID
+    property :status
+    property :mcID
+    property :storeID
+    property :customerID
+    property :purchaseDate
+    property :shippingAddress
+    property :billingAddress
+    property :items
+    property :tax
+    property :shippingAndHandling
+    property :properties
+  end
+end

data/lib/cordial/orders.rb

@@ -36,36 +36,21 @@ module Cordial
     end
 
     # Create a new order.
-    # Posting more than one time the same "orderID" name will generate an error.
+    #
+    # This endpoint does not support the idea of an upsert like others do.
+    # Subsequent calls will fail.
     #
     # @example Usage.
-    # Cordial::Orders.create(
-    #   id: 1,
-    #   email: 'cordial@example.com',
-    #   link_id: '123456',
-    #   mc_id: '645:5b6a1f26e1b829b63c2a7946:ot:5aea409bbb3dc2f9bc27158f:1',
-    #   purchase_date: '2015-01-09 17:47:43',
-    #   items: [{productID: '1',
-    #            sku: '123',
-    #            name: 'Test product',
-    #            attr: { color: 'blue', size: 'L' }}])
-    # @example response whe the orderID is not on cordial
+    # Cordial::Orders.create({...})
+    #
+    # @example response when the orderID is not on cordial
     # {"success"=>true}
     #
     # @example Response when orderID already exist on cordial.
     # {"error"=>true, "messages"=>"ID must be unique"}
-    def self.create(id:, email:, purchase_date:, items:, link_id: nil, mc_id: nil)
-      body = {
-        orderID: id,
-        email: email,
-        purchaseDate: purchase_date,
-        items: items
-      }
-
-      body[:linkID] = link_id unless link_id.nil?
-      body[:mcID] = mc_id unless mc_id.nil?
-
-      client.post('/orders', body: body.to_json)
+    def self.create(options)
+      order = Cordial::Order.new(options)
+      client.post('/orders', body: order.to_json)
     end
   end
 end

data/lib/cordial/version.rb

@@ -1,3 +1,3 @@
 module Cordial
-  VERSION = '0.1.10'.freeze
+  VERSION = '0.1.11'.freeze
 end

data/lib/cordial.rb

@@ -1,11 +1,18 @@
-require "httparty"
-require "utils/compact"
-require "cordial/version"
-require "cordial/client"
-require "cordial/contacts"
-require "cordial/products"
-require "cordial/orders"
-require "cordial/automation_templates"
+require 'hashie'
+require 'httparty'
+require 'utils/compact'
+
+require 'cordial/version'
+require 'cordial/client'
+
+# Models
+require 'cordial/order'
+
+# Controllers
+require 'cordial/contacts'
+require 'cordial/products'
+require 'cordial/orders'
+require 'cordial/automation_templates'
 
 module Cordial
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cordial
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Andrew Hood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2018-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -39,61 +53,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -144,12 +172,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.sample"
-- ".env.test"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
+- History.md
 - README.md
 - Rakefile
 - bin/console
@@ -159,6 +189,7 @@ files:
 - lib/cordial/automation_templates.rb
 - lib/cordial/client.rb
 - lib/cordial/contacts.rb
+- lib/cordial/order.rb
 - lib/cordial/orders.rb
 - lib/cordial/products.rb
 - lib/cordial/version.rb
@@ -183,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Cordial API Client

data/.env.test

@@ -1 +0,0 @@
-API_KEY='cordial-api-key'