chord 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6da5791c0fe9f32d72d827bc87ae15186cadbff18bfceecee81b98f17c3111a0
-  data.tar.gz: 037ad832506b87180563ce7ab0d8fbf591bcef211e1a72abe1110292329052dc
+  metadata.gz: 4caa956b7d9f279a1973f2a5ad5e63f0078697ecb1fc129fcff09c10dfcdbbc3
+  data.tar.gz: c4a93aa0e26f11d6bb42b7345b1dead92f685eafb43d96fa34516d05eb3a09a2
 SHA512:
-  metadata.gz: afd04a08a2150ee30708c5ded7ec9a795839cfe606e17e9633691a76e2820346a7127995374639a8bbda0a20b39d529380b1b60810fee7993ad68983ae904fc5
-  data.tar.gz: d9c99564446ead46f5155f6efa8ae6efed6caa28d6ac64241f4be70fb6f4f674f3f9b228610ebf8a1d41dd8cf7d81b279942d5bcb25368ba877dd90d88506dbf
+  metadata.gz: 8fa44ce53bc77f079140bab0838a66196314f103f3c515ea8dd90c9341af047fa5afb19925189a864652590d4fcf2f431095ceb4cbbde99725085dd72477206e
+  data.tar.gz: f30e7aa9d991c7822ab93777a8a6de9c9f6df943a83d8bf7c629a2b1f3ba18bc485d570a2aa152ca14f2e01d6b3e794925d1cf931199ad76f78a3ddb868b9feb

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 Major changes for each release. Please see the Git log for complete list of changes.
 
+## 0.0.7
+
+* Remove ActiveRecord dependency.
+* Make some methods private.
+* Raise APIError when no data returned.
+
+## 0.0.6
+
+* Return User objects from Role#users.
+* Add config methods.
+
 ## 0.0.5
 
 * Add expand! method.

data/README.md

@@ -8,22 +8,72 @@ These classes provide simple read and write access to the Chord OMS API. Get sta
     )
 
     u = Chord::User.find(1)                   # fetch user
-    u.attributes                              # see attributes hash
-    u.update(name: 'New Name', notes: 'Etc')  # update attributes
-    u.update(metadata: {ambassador_id: 415})  # when updating 'metadata' attribute, the given
-                                              # hash is merged into the existing value and
-                                              # keys and values are stringified (since
-                                              # metadata is stored in OMS as a JSON string)
+    u.email                                   # view an attribute
+    u.attributes                              # see all attributes (returns hash)
+    u.update(name: 'Joe Smith', notes: 'Etc') # update attributes
     u.add_role(3)                             # add role (by ID) to the user
     u.remove_role(3)                          # remove role (by ID) from the user
     u.subscriptions                           # fetch the user's subscriptions
 
+    o = Chord::Order.find(1)                  # fetch order
+    o.subscription_installment?               # was the order a subscription installment?
+    o.subscription_start?                     # did the order start a subscription?
+
+For complete/current list of supported objects and methods, please see the code.
+
+
+## Querying
+
+The most basic way to get a collection of objects:
+
+    Chord::Order.all
+
+You can also filter and sort, though the parameters are not well documented:
+
+    Chord::Order.where(
+      'q[completed_at_gt]' => '2022-09-14',
+       'q[s]' => 'completed_at desc'
+    )
+
+
+## Object attributes
+
 Objects are constructed in a way that minimizes API calls but occasionally yields objects that seem incomplete. For example:
 
     orders = Chord::Order.all
     o = orders.first
 
-will return a Chord::Order object with around 40 attributes, not the full set of 55 (it's missing line items, for example), because the `/orders` endpoint returns abbreviated objects. To load the full set of data for these objects, use the `expand!` method:
+will return a Chord::Order object with around 40 attributes, not the full set of 55 (it's missing line items, for example), because the `/orders` endpoint returns abbreviated objects. To load the full set of data for such an object, use the `expand!` method:
 
     o.expand!
 
+
+# Configuration options
+
+To get your sensitive config data out of your code, you can put it in a YAML file, like so:
+
+    # chord_config.yml
+    base_url: https://...
+    api_key: ...
+
+and load it by calling:
+
+    Chord.config_from_file('chord_config.yml')
+
+Or you can put your configuration in environment variables:
+
+    CHORD_BASE_URL=https://...
+    CHORD_API_KEY=...
+
+and load it by calling:
+
+    Chord.config_from_env
+
+Both config-loading methods return a boolean indicating whether configuration data was found and loaded, so you can easily fall back from one method to the other, for example:
+
+    Chord.config_from_env or Chord.config_from_file('chord_config.yml')
+
+
+# To Do
+
+* tests should use mocks instead of real API requests

data/lib/chord/version.rb

@@ -1,3 +1,3 @@
 module Chord
-  VERSION = "0.0.5"
+  VERSION = "0.0.7"
 end

data/lib/chord.rb

@@ -7,8 +7,8 @@ module Chord
     attr_accessor :api_key
 
     def config(options)
-      self.base_url = options[:base_url]
-      self.api_key = options[:api_key]
+      self.base_url = options[:base_url] if options[:base_url]
+      self.api_key = options[:api_key] if options[:api_key]
     end
 
     def config_from_file(filepath)
@@ -19,6 +19,20 @@ module Chord
           base_url: config[:base_url],
           api_key: config[:api_key]
         )
+      else
+        false
+      end
+    end
+
+    def config_from_env
+      if ENV['CHORD_BASE_URL'] or ENV['CHORD_API_KEY']
+        Chord.config(
+          base_url: ENV['CHORD_BASE_URL'],
+          api_key: ENV['CHORD_API_KEY']
+        )
+        true
+      else
+        false
       end
     end
   end
@@ -31,33 +45,22 @@ module Chord
       def per_page; 99999; end
 
       def all
+        check_for_config!
         @all ||= fetch_all_data[base_path].map{ |i| new(i[id_attribute], i) }
       end
 
       def where(query_options = {})
+        check_for_config!
         fetch_all_data(query_options)[base_path].map{ |i| new(i[id_attribute], i) }
       end
 
       def find(id)
+        check_for_config!
         return nil if id.nil? or id == ''
         attrs = fetch_attributes(id)
         attrs.include?('error') ? nil : new(attrs[id_attribute], attrs)
       end
 
-      def fetch_attributes(id)
-        get(base_url + "#{base_path}/#{id}", http_options).parsed_response
-      end
-
-      def id_attribute
-        'id'
-      end
-
-      def fetch_all_data(query_options = {})
-        query_options = { per_page: per_page }.merge(query_options)
-        url = base_url + base_path + '?' + hash_to_query(query_options)
-        get(url, http_options).parsed_response
-      end
-
       def base_url
         Chord.base_url
       end
@@ -71,6 +74,28 @@ module Chord
 
       private # --------------------------------------------------------------
 
+      def id_attribute
+        'id'
+      end
+
+      def fetch_attributes(id)
+        check_for_config!
+        get(base_url + "#{base_path}/#{id}", http_options).parsed_response or raise APIError, 'No data returned by API'
+      end
+
+      def fetch_all_data(query_options = {})
+        check_for_config!
+        query_options = { per_page: per_page }.merge(query_options)
+        url = base_url + base_path + '?' + hash_to_query(query_options)
+        get(url, http_options).parsed_response or raise APIError, 'No data returned by API'
+      end
+
+      def check_for_config!
+        if Chord.base_url.nil? or Chord.api_key.nil?
+          raise ConfigurationError, 'Please configure Chord by calling Chord.config(base_url: ..., api_key: ...)'
+        end
+      end
+
       def hash_to_query(hash)
         require 'cgi' unless defined?(CGI) && defined?(CGI.escape)
         hash.collect{ |p|
@@ -100,14 +125,6 @@ module Chord
     end
 
     def update(new_attributes)
-      new_attributes.stringify_keys!
-      # merge values into existing metadata
-      if new_attributes.include?('metadata')
-        # Chord expects all metadata values to be strings
-        new_metadata = new_attributes['metadata'].map{ |k,v| [k.to_s, v.to_s] }.to_h
-        new_attributes['metadata'] = (attributes['metadata'] || {}).merge(new_metadata)
-        # TODO: delete entries with empty value?
-      end
       self.attributes = self.class.patch(base_url + "#{base_path}/#{id}",
         http_options.merge(body: new_attributes.to_json)
       ).parsed_response
@@ -120,7 +137,7 @@ module Chord
     # fetch all attributes, but don't overwrite existing ones,
     # in case changes have been made
     def expand!
-      all_attributes = self.class.fetch_attributes(id)
+      all_attributes = self.class.send(:fetch_attributes, id)
       @attributes = all_attributes.merge(@attributes)
     end
 
@@ -228,6 +245,10 @@ module Chord
     def self.base_path
       'roles'
     end
+
+    def users
+      attributes['users'].map{ |u| Chord::User.new(u['id'], u) }
+    end
   end
 
 
@@ -248,4 +269,10 @@ module Chord
       'products'
     end
   end
+
+  class ConfigurationError < StandardError
+  end
+
+  class APIError < StandardError
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chord
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-20 00:00:00.000000000 Z
+date: 2022-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -52,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="