chord 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6da5791c0fe9f32d72d827bc87ae15186cadbff18bfceecee81b98f17c3111a0
-  data.tar.gz: 037ad832506b87180563ce7ab0d8fbf591bcef211e1a72abe1110292329052dc
+  metadata.gz: 82b29351f996510a42975aa338c2ece2744e49780e4c31b2c265593a2707824c
+  data.tar.gz: 7bc61180788440328b85083997629d9d63ddf7496c2a5702869973a6ca4ce238
 SHA512:
-  metadata.gz: afd04a08a2150ee30708c5ded7ec9a795839cfe606e17e9633691a76e2820346a7127995374639a8bbda0a20b39d529380b1b60810fee7993ad68983ae904fc5
-  data.tar.gz: d9c99564446ead46f5155f6efa8ae6efed6caa28d6ac64241f4be70fb6f4f674f3f9b228610ebf8a1d41dd8cf7d81b279942d5bcb25368ba877dd90d88506dbf
+  metadata.gz: a9694514bb6710a41ab0a3331f9e9fdcbe0c36945304384e7b0b4207f93d323c1c65e10eed77cdbddaea566f325a2354918d43cbdf978d32224a57665826298e
+  data.tar.gz: 2e2b02f34e13133d93f70693670e423250aa16090165b87484eee2927dca52d48b791ef1ac7ec914aa87dd6aca09e4726942a2d55a23ddf198f2df2f74e90ac5

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 Major changes for each release. Please see the Git log for complete list of changes.
 
+## 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
+    u.update(metadata: {legacy_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)
+
+    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')
+

data/lib/chord/version.rb

@@ -1,3 +1,3 @@
 module Chord
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 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
@@ -228,6 +242,10 @@ module Chord
     def self.base_path
       'roles'
     end
+
+    def users
+      attributes['users'].map{ |u| Chord::User.new(u['id'], u) }
+    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.6
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-20 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty