cordial 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e83d1045ce86b44e14a66dfc67a56f1e70e8b995
-  data.tar.gz: bbb0cdcaae5b4db569edad3a38f4c0dc26519f06
+SHA256:
+  metadata.gz: a30b36da7c22388a85a10b02e98f79268c07989a31e98f62b9f57e6dc9313b77
+  data.tar.gz: ba66580215145c937bbdf8fd002a73384e3206137d6cd96b41e1a4683aacff6d
 SHA512:
-  metadata.gz: cda227ed6d6eefb76cffb11f7cd141490e3dec7cf00692a01b6a1de725e90d9549de97fcb14a68216dac9b844d5b4b9e74341cef209514bbc5596e852b1c95cb
-  data.tar.gz: b7d98185f7a344633b055e14354b617f01f6de01c2f6123ce3cafcd946d78d6bfe7002025057eb0431585cd869216faf03eaac9091cc46006ae8a64f13376740
+  metadata.gz: 88fead131ea85e1499240b3016a705c8abf855295891151af79c53661267ba8dba5d5f9ea45817bcefa54115fccfa76c33fd87373fb3951d57cd358d4614a18a
+  data.tar.gz: 4f8154e2389142ba92e4bb90253ce84351a7991eb6d88d35e5466c96e5607eed13ee60c28443918c4ecb6a7c707bde9977da52a6735b24ad58ce8bc0c6cda696

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+2.5.1

data/.travis.yml

@@ -1,5 +1,9 @@
-sudo: false
 language: ruby
-rvm:
-  - 2.3.4
-before_install: gem install bundler -v 1.15.3
+
+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
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/README.md

@@ -1,8 +1,11 @@
 # Cordial
 
-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/cordial`. To experiment with that code, run `bin/console` for an interactive prompt.
+[ ![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)
 
-TODO: Delete this and the text above, and describe your gem
+A ruby gem to interact with the [Cordial API](https://api.cordial.io/docs/v1/).
 
 ## Installation
 
@@ -20,9 +23,17 @@ Or install it yourself as:
 
     $ gem install cordial
 
+```ruby
+Cordial.configure do |config|
+  config.api_key = 'your-api-key'
+end
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+Cordial::Contact.create(email: 'hello@world')
+```
 
 ## Development
 
@@ -32,4 +43,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cordial.
+Bug reports and pull requests are welcome!

data/cordial.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "httparty", "~> 0.16"
 
   spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  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"

data/lib/cordial/client.rb

@@ -6,6 +6,7 @@ module Cordial
     def client
       base_uri 'https://api.cordial.io/v1'
       basic_auth(Cordial.config.api_key, '')
+      headers 'Content-Type' => 'application/json'
       self
     end
   end

data/lib/cordial/contacts.rb

@@ -1,23 +1,74 @@
 module Cordial
-  # https://api.cordial.io/docs/v1/#!/contacts
+  # Wraps all interaction with the Contact resource.
+  # @see https://api.cordial.io/docs/v1/#!/contacts
   class Contacts
     include ::HTTParty
     extend Client
 
+    # Find a contact.
+    # @example Usage
+    #  Cordial::Contacts.find(email: 'hello@world.earth')
+    # @example Response when the contact was found.
+    #   {
+    #     "_id" => "111122223334444",
+    #     "channels" => {
+    #       "email" => {
+    #         "address" => "hello@world.earth",
+    #         "subscribeStatus" => "unsubscribed",
+    #         "unsubscribedAt" => "2018-05-02T23:35:38+0000"
+    #       }
+    #     },
+    #     "lastModified" => "2018-05-16T22:57:16+0000",
+    #     "createdAt" => "2018-04-25T19:55:45+0000",
+    #     "lists" => ["test-list"],
+    #     "lj" => {
+    #       "14854" => {
+    #         "sec" => 1524897139,
+    #         "usec" => 0
+    #        }
+    #      },
+    #      "listJoinDate" => {
+    #        "test-list" => "2018-04-28T06:32:19+0000"
+    #      }
+    #    }
+    #
+    # @example Response when the contact was not found.
+    #  {"error"=>true, "message"=>"record not found"}
     def self.find(email:)
       client.get("/contacts/#{email}")
     end
 
-    def self.create(email:, attribute_list:)
+    # Create a new contact.
+    #
+    # If the contact already exists it will be updated.
+    # @example Usage.
+    #  Cordial::Contacts.create(
+    #    email: 'hello@world.earth',
+    #    attribute_list: {
+    #      some_attribute: 'your-custom-value'
+    #    },
+    #    subscribe_status: 'subscribed'
+    #  )
+    def self.create(email:, attribute_list: {}, subscribe_status: nil)
       client.post('/contacts', body: {
         channels: {
           email: {
-            address: email
-          }
-        }
-      }.merge(attribute_list))
+            address: email,
+            subscribeStatus: subscribe_status
+          }.compact
+        },
+        forceSubscribe: subscribe_status == 'subscribed' || nil
+      }.compact.merge(attribute_list).to_json)
     end
 
+    # Unsubscribe a contact.
+    #
+    # @param channel [String] The channel to unsubscribe, defaults to `email`
+    # @see https://support.cordial.com/hc/en-us/articles/115001319432-Channels-Overview
+    # @example Usage. Default channel.
+    #  Cordial::Contacts.unsubscribe(
+    #    email: 'hello@world.earth'
+    #  )
     def self.unsubscribe(email:, channel: 'email')
       client.put("/contacts/#{email}/unsubscribe/#{channel}")
     end

data/lib/cordial/products.rb

@@ -0,0 +1,61 @@
+module Cordial
+  # Wraps all interaction with the Product resource.
+  # @see https://api.cordial.io/docs/v1/#!/products
+  class Products
+    include ::HTTParty
+    extend Client
+
+    # Find a product.
+    # @example Usage
+    #  Cordial::products.find(product_id: 1)
+    # @example Response when the product was found.
+    # {
+    #   "_id"=>"5b28275fe1dc0fa0c872abec",
+    #   "productID"=>"1",
+    #   "productName"=>"Test Product",
+    #   "price"=>10,
+    #   "variants"=>[
+    #     {
+    #       "sku"=>"123456789",
+    #       "attr"=>{"color"=>"blue", "size"=>"Large"},
+    #       "qty"=>"10"}
+    #   ],
+    #   "accountID"=>645,
+    #   "totalQty"=>10,
+    #   "lm"=>"2018-06-18T21:42:55+0000",
+    #   "ct"=>"2018-06-18T21:42:55+0000"
+    # }
+    #
+    # @example Response when the product was not found.
+    #  {"error"=>true, "message"=>"record not found"}
+    def self.find(id:)
+      client.get("/products/#{id}")
+    end
+
+    # Create a new product.
+    #
+    # If the product already exists it will be updated.
+    # @example Usage.
+    #  Cordial::Products.create(
+    #    product_id: 1,
+    #    product_name: 'Test Product',
+    #    price: 99.99,
+    #    variants: [{
+    #      sku: '123',
+    #      attr: {
+    #        color: 'red',
+    #        size: 'L'
+    #      }
+    #    }]
+    #  )
+    def self.create(id:, name:, price:, variants:)
+      client.post('/products',
+                  body: {
+                    productID: id,
+                    productName: name,
+                    price: price,
+                    variants: variants
+                  }.to_json)
+    end
+  end
+end

data/lib/cordial/version.rb

@@ -1,3 +1,3 @@
 module Cordial
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'.freeze
 end

data/lib/cordial.rb

@@ -2,6 +2,7 @@ require "httparty"
 require "cordial/version"
 require "cordial/client"
 require "cordial/contacts"
+require "cordial/products"
 
 module Cordial
   class << self
@@ -14,6 +15,6 @@ module Cordial
   end
 
   class Configuration
-    attr_accessor :api_key, :api_url
+    attr_accessor :api_key
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cordial
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrew Hood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +130,7 @@ files:
 - lib/cordial.rb
 - lib/cordial/client.rb
 - lib/cordial/contacts.rb
+- lib/cordial/products.rb
 - lib/cordial/version.rb
 homepage: https://github.com/MeUndies/cordial
 licenses:
@@ -151,7 +152,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