chord 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d87fc026e550a99125b7aac97b1069d943ccc8b6c23f4bface9ae5136d2fd48d
-  data.tar.gz: ca017e9919b6323d25f0dbac900598be630c843120bef07f1db29787e94b675d
+  metadata.gz: 82b29351f996510a42975aa338c2ece2744e49780e4c31b2c265593a2707824c
+  data.tar.gz: 7bc61180788440328b85083997629d9d63ddf7496c2a5702869973a6ca4ce238
 SHA512:
-  metadata.gz: e027f417299124bbcf66d573ddd4ddb36f9a3c3d193385df49b2499ed9658543b58375064ba4cd583777a66be63ef685c036ba3616f7813bd34ebd857753d34a
-  data.tar.gz: fc10bf3c2ff5b9fd59048024ff07f3288b9593aea3da6a90fc35b11697d992bdcc48b00d873bbc07685b63440e9a228dc27330409568d98073f1e9adc51c0416
+  metadata.gz: a9694514bb6710a41ab0a3331f9e9fdcbe0c36945304384e7b0b4207f93d323c1c65e10eed77cdbddaea566f325a2354918d43cbdf978d32224a57665826298e
+  data.tar.gz: 2e2b02f34e13133d93f70693670e423250aa16090165b87484eee2927dca52d48b791ef1ac7ec914aa87dd6aca09e4726942a2d55a23ddf198f2df2f74e90ac5

data/CHANGELOG.md

@@ -2,9 +2,19 @@
 
 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.
+* Fix Order object IDs.
+
 ## 0.0.4
 
-* Load attribute if missing.
+* Load subscription_in_cart attribute if missing when it's needed.
 
 ## 0.0.3
 

data/README.md

@@ -8,21 +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:
 
-    u = Chord::User.find(44)
-    s = u.subscriptions.first
-    s.user
+    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 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:
 
-will return a Chord::User object with only two attributes (ID and email) because the API only returns two attributes with a Subscription object.
+    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.4"
+  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
@@ -28,20 +42,28 @@ module Chord
 
     class << self
       attr_writer :per_page
-      def per_page; @per_page || 99999; end
+      def per_page; 99999; end
 
       def all
-        @all ||= fetch_all_data[base_path].map{ |i| new(i['id'], i) }
+        @all ||= fetch_all_data[base_path].map{ |i| new(i[id_attribute], i) }
       end
 
       def where(query_options = {})
-        fetch_all_data(query_options)[base_path].map{ |i| new(i['id'], i) }
+        fetch_all_data(query_options)[base_path].map{ |i| new(i[id_attribute], i) }
       end
 
       def find(id)
         return nil if id.nil? or id == ''
-        attrs = get(base_url + "#{base_path}/#{id}", http_options).parsed_response
-        attrs.include?('error') ? nil : new(id, attrs)
+        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 = {})
@@ -109,6 +131,13 @@ module Chord
       self.class.delete(base_url + "#{base_path}/#{id}", http_options).parsed_response
     end
 
+    # fetch all attributes, but don't overwrite existing ones,
+    # in case changes have been made
+    def expand!
+      all_attributes = self.class.fetch_attributes(id)
+      @attributes = all_attributes.merge(@attributes)
+    end
+
     def method_missing(method, *args, &block)
       if attributes.include?(method.to_s)
         attributes[method.to_s]
@@ -175,8 +204,12 @@ module Chord
       'orders'
     end
 
+    def self.id_attribute
+      'number'
+    end
+
     def user
-      Chord::User.find(attributes['user_id'])
+      @user ||= Chord::User.find(attributes['user_id'])
     end
 
     def payments
@@ -198,9 +231,7 @@ module Chord
     end
 
     def subscription_start?
-      unless attributes.include?('subscription_in_cart')
-        attributes['subscription_in_cart'] = Chord::Order.find(number).subscription_in_cart
-      end
+      expand! unless attributes.include?('subscription_in_cart')
       subscription_in_cart
     end
   end
@@ -211,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.4
+  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