recharge-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 38da2ffc86ba27bea660a00c153e74ffe72fc054
-  data.tar.gz: eed4ac714a4c95f27791c196fbe8c74a2e458b63
+SHA256:
+  metadata.gz: 9f3a7eb0f67af92f82030c6051b89285c6b12a0e6eeb6d959d0b3ce9ca467c62
+  data.tar.gz: 2ee8e765979f5b691ac980e9a4cc691069e6bfe1b672d36ddd0a816ecaaabed8
 SHA512:
-  metadata.gz: 3b0e967d97687f1df95f7c981bae8846fd62736e246ff186087c40fb005f4711321652450475ccaff461b7ff915c3e7d4479c74e8021fe5794b67c7b1902a171
-  data.tar.gz: fab06c67606cd8052deb664ebaea1d1adc1b7615cd6777080c737ccfb05ea53bf0fc56e4ab02a4cab480c3c05c333b5297410d5fbb2702f1c27c3e6c3d44ec3a
+  metadata.gz: 6ea64a155cd959427bf2e7cc39c2e657ee9e42915a13639b26fc58146b4a061c489d92dfdca43dd6e8266be6ef6c47a600e67522f9a1a973c9eea73999565024
+  data.tar.gz: ec422be602cb58ac9272bb70bee0a53a4423f94986c9fed5a1626c6e0e6c8db988cf02db64a9eb2563b5857c86c8874b681117a24a840e46bbc21aa0de7a661e

data/.travis.yml

@@ -1,12 +1,15 @@
 language: ruby
 sudo: false
+cache: bundler
 rvm:
-  - 2.1
-  - 2.2
   - 2.3
   - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
 
-before_install: gem update bundler
+before_install:
+  - gem update bundler
 
 notifications:
   email: false

data/README.md

@@ -17,6 +17,9 @@ Bundler:
 
 ## Usage
 
+An API key is required. The key can be set via `ReCharge.api_key` or via the `RECHARGE_API_KEY`
+environment variable.
+
 ```rb
 require "recharge"
 
@@ -64,16 +67,27 @@ For complete documentation refer to the API docs: http://rdoc.info/gems/recharge
 
 ## Rake Tasks for Webhook Management
 
-Requiring `recharge/tasks` will include several Rake tasks for webhook management.
-All tasks require `RECHARGE_API_KEY` be set.
+Add the following to your `Rakefile`:
+
+```rb
+require "recharge/tasks"
+```
 
-The hooks are:
+This will add the following tasks:
 
   * `recharge:hook:create` - create webhook `HOOK` to be sent to `CALLBACK`
   * `recharge:hooks:delete` - delete the webhook(s) given by `ID`
   * `recharge:hooks:delete_all` - delete all webhooks
   * `recharge:hooks:list` - list webhooks
 
+All tasks require `RECHARGE_API_KEY` be set.
+
+For example, to create a hook run the following:
+
+```
+rake recharge:hooks:create RECHARGE_API_KEY=YOURKEY HOOK=subscription/created CALLBACK=https://example.com/callback
+```
+
 ## License
 
 Released under the MIT License: www.opensource.org/licenses/MIT

data/lib/recharge.rb

@@ -11,7 +11,8 @@ module Recharge
   ConnectionError = Class.new(Error)
 
   #
-  # Raised when a non-2XX HTTP response is returned
+  # Raised when a non-2XX HTTP response is returned or a response with
+  # an error or warning property
   #
   class RequestError < Error
     attr_accessor :errors

data/lib/recharge/classes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "json"
 require "class2"
 require "recharge/http_request"
@@ -8,28 +10,42 @@ class2 "Recharge", JSON.parse(<<-END) do
      {
         "id":10101,
         "address_id":178918,
+        "analytics_data": {},
         "customer_id":1438,
+        "cancellation_reason": "$$$$",
+        "cancellation_reason_comments": "",
+        "cancelled_at":"2017-02-28T20:31:29",
+        "charge_interval_frequency": "3",
         "created_at":"2017-02-28T20:31:29",
         "updated_at":"2017-02-28 20:31:29",
         "next_charge_scheduled_at":"2017-04-01T00:00:00",
         "cancelled_at":null,
+        "has_queued_charges": 1,
+        "is_skippable": true,
+        "is_swappable": true,
+        "is_prepaid": false,
+        "max_retries_reached": 0,
         "product_title":"Sumatra Coffee",
         "price":12,
         "quantity":1,
+        "recharge_product_id": 518676,
         "status":"ACTIVE",
         "shopify_product_id":1255183683,
         "shopify_variant_id":3844924611,
+        "sku_override": false,
         "sku":null,
         "order_interval_unit":"day",
         "order_interval_frequency":"30",
         "charge_interval_frequency":"30",
         "order_day_of_month":null,
         "order_day_of_week":null,
-        "properties": []
+        "properties": [],
+        "variant_title": "Milk - a / b"
      },
   "charge":
     {
       "address_id":178918,
+      "analytics_data": {},
       "billing_address":{
          "address1":"3030 Nebraska Avenue",
          "address2":"",
@@ -50,11 +66,13 @@ class2 "Recharge", JSON.parse(<<-END) do
       "customer_hash":null,
       "customer_id":10101,
       "first_name":"Mike",
+      "has_uncommited_changes": false,
       "id":1843,
       "last_name":"Flynn",
       "line_items":[
          {
             "grams":0,
+            "images": {},
             "price":100.0,
             "properties":[],
             "quantity":1,
@@ -67,6 +85,9 @@ class2 "Recharge", JSON.parse(<<-END) do
             "subscription_id":14562
          }
       ],
+      "note": "blah blah",
+      "note_attributes": [],
+      "processor_name": "foo",
       "processed_at":"2014-11-20T00:00:00",
       "scheduled_at":"2014-11-20T00:00:01",
       "shipments_count":null,
@@ -82,10 +103,20 @@ class2 "Recharge", JSON.parse(<<-END) do
          "province":"California",
          "zip":"90404"
       },
+      "shipping_lines": [],
       "shopify_order_id":"281223307",
       "status":"SUCCESS",
       "total_price":446.00,
-      "updated_at":"2016-09-05T09:19:29"
+      "updated_at":"2016-09-05T09:19:29",
+      "tax_lines": 0,
+      "total_discounts": "0.0",
+      "total_line_items_price": "12.00",
+      "total_price": "12.00",
+      "total_refunds": null,
+      "total_tax": 0,
+      "total_weight": 4536,
+      "transaction_id": "cch_1Du2QpJ2iqHvZRd18RyqoPvc",
+      "type": "RECURRING"
     },
   "customer":
      {
@@ -108,7 +139,10 @@ class2 "Recharge", JSON.parse(<<-END) do
         "billing_country": "United States",
         "billing_phone": "3103843698",
         "processor_type": null,
-        "status": "FOO"
+        "status": "FOO",
+        "stripe_customer_token": "123123",
+        "paypal_customer_token": "123123",
+        "braintree_customer_token": "123123"
     },
   "order": {
      "id":7271806,
@@ -168,11 +202,49 @@ class2 "Recharge", JSON.parse(<<-END) do
         "country":"United States"
      }
   },
-  "webhook":
-    {
-        "id":6,
-        "address":"https://request.in/foo",
-        "topic":"order/create"
+  "metafield": {
+    "created_at": "2018-11-05T12:59:30",
+    "description": "desc lorem ipsum",
+    "id": 15,
+    "key": "marjan",
+    "namespace": "nmsp2c",
+    "owner_id": 17868054,
+    "owner_resource": "customer",
+    "updated_at": "2018-11-05T15:48:42",
+    "value": "5",
+    "value_type": "integer"
+  },
+  "product": {
+    "collection_id": null,
+    "created_at": "2019-11-07T11:36:19",
+    "discount_amount": 15.0,
+    "discount_type": "percentage",
+    "handle": null,
+    "id": 1327844,
+    "images": {},
+    "product_id": 4354268856408,
+    "shopify_product_id": 4354268856408,
+    "subscription_defaults": {
+      "charge_interval_frequency": 4,
+      "cutoff_day_of_month": null,
+      "cutoff_day_of_week": null,
+      "expire_after_specific_number_of_charges": null,
+      "modifiable_properties": [],
+      "number_charges_until_expiration": null,
+      "order_day_of_month": 0,
+      "order_day_of_week": null,
+      "order_interval_frequency": 4,
+      "order_interval_frequency_options": [],
+      "order_interval_unit": "month",
+      "storefront_purchase_options": "subscription_only"
+    },
+    "title": "T-shirt",
+    "updated_at": "2019-11-07T14:04:52"
+  },
+  "webhook": {
+     "id":6,
+     "address":"https://request.in/foo",
+     "topic":"order/create"
   },
   "address":{
     "id":3411137,
@@ -186,6 +258,26 @@ class2 "Recharge", JSON.parse(<<-END) do
     "company":"bootstrap",
     "phone":"3103103101",
     "country":"United States"
+  },
+  "discount":{
+    "id": 3748296,
+    "code": "Discount1",
+    "value": 12,
+    "ends_at": "2019-12-15T00:00:00",
+    "starts_at": "2018-05-16T00:00:00",
+    "status": "enabled",
+    "usage_limit": 10,
+    "applies_to_id": null,
+    "discount_type": "percentage",
+    "applies_to": null,
+    "applies_to_resource": null,
+    "times_used": 0,
+    "duration": "usage_limit",
+    "duration_usage_limit": 10,
+    "applies_to_product_type": "ALL",
+    "created_at": "2018-04-25T14:32:39",
+    "updated_at": "2018-05-04T13:33:53",
+    "once_per_customer": false
   }
 }
 END
@@ -348,6 +440,58 @@ module Recharge
     end
   end
 
+  class Discount
+    PATH = "/discounts".freeze
+    SINGLE = "discount".freeze
+    COLLECTION = "discounts"
+
+    extend HTTPRequest::Count
+    extend HTTPRequest::Create
+    extend HTTPRequest::Delete
+    extend HTTPRequest::Get
+    extend HTTPRequest::List
+    extend HTTPRequest::Update
+
+    include Persistable
+
+    def self.count(options = nil)
+      super(convert_date_params(options, :created_at_max, :created_at_min, :date_min, :date_max))
+    end
+
+    def self.list(options = nil)
+      super(convert_date_params(options, :created_at, :created_at_max, :updated_at, :updated_at_max))
+    end
+
+    def delete
+      self.class.delete(id)
+      true
+    end
+  end
+
+  class Metafield
+    PATH = "/metafields"
+    SINGLE = "metafield"
+    COLLECTION = "metafields"
+
+    extend HTTPRequest::Count
+    extend HTTPRequest::Create
+    extend HTTPRequest::Delete
+    extend HTTPRequest::Get
+    extend HTTPRequest::List
+
+    include Persistable
+
+    def self.list(owner, options = nil)
+      raise ArgumentError, "owner resource required" if owner.nil? || owner.to_s.strip.empty?
+      super (options||{}).merge(:owner_resource => owner)
+    end
+
+    def delete
+      self.class.delete(id)
+      true
+    end
+  end
+
   class Order
     PATH = "/orders".freeze
     SINGLE = "order".freeze
@@ -373,6 +517,16 @@ module Recharge
     end
   end
 
+  class Product
+    PATH = "/products".freeze
+    SINGLE = "product".freeze
+    COLLECTION = "products".freeze
+
+    extend HTTPRequest::Count
+    extend HTTPRequest::Get
+    extend HTTPRequest::List
+  end
+
   class Subscription
     PATH = "/subscriptions".freeze
     SINGLE = "subscription".freeze

data/lib/recharge/http_request.rb

@@ -3,8 +3,8 @@ require "uri"
 require "json"
 
 # For iso8601
-require "date"
-require "time"
+#require "date"
+#require "time"
 
 module Recharge
   module HTTPRequest # :nodoc:
@@ -56,7 +56,7 @@ module Recharge
     private
 
     def request(req, data = {})
-      req[TOKEN_HEADER] = ReCharge.api_key || ""
+      req[TOKEN_HEADER] = ReCharge.api_key || ENV["RECHARGE_API_KEY"] || ""
       req["User-Agent"] = USER_AGENT
 
       if req.request_body_permitted? && data && data.any?
@@ -66,7 +66,8 @@ module Recharge
 
       connection.start do |http|
         res = http.request(req)
-        data = res["Content-Type"] == "application/json" ? parse_json(res.body) : {}
+        # API returns 204 but content-type header is set to application/json so check body
+        data = res.body && res["Content-Type"] == "application/json" ? parse_json(res.body) : {}
         data["meta"] = { "id" => res["X-Request-Id"], "limit" => res["X-Recharge-Limit"] }
 
         return data if res.code[0] == "2" && !data["warning"] && !data["error"]
@@ -185,7 +186,7 @@ module Recharge
     end
 
     #
-    # Retrieve a page of records for the included/extended class'
+    # Retrieve a page of records for the included/extended class' endpoint
     #
     # === Arguments
     #

data/lib/recharge/version.rb

@@ -1,3 +1,3 @@
 module Recharge
-  VERSION = "0.0.1".freeze
+  VERSION = "0.0.2".freeze
 end

data/recharge-api.gemspec

@@ -20,8 +20,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "class2", "~> 0.3.0"
+  # Keep this until we can upgrade class2
+  # We don't upgrade yet because versions > 3 default to Symbol keys
+  spec.add_dependency "activesupport", "< 6"
   spec.add_development_dependency "webmock", "~> 3.0"
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recharge-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Skye Shaw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-06 00:00:00.000000000 Z
+date: 2020-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: class2
@@ -25,47 +25,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: '6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Client for ReCharge Payments API