chord 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82b29351f996510a42975aa338c2ece2744e49780e4c31b2c265593a2707824c
-  data.tar.gz: 7bc61180788440328b85083997629d9d63ddf7496c2a5702869973a6ca4ce238
+  metadata.gz: 8f0f6af63adad1bbb028d80575a89a9edcbb424125446e7d8b7c6988d110afd9
+  data.tar.gz: ed4caff66b9252177a0bb9ee2a173db714f6da72e893146abab367c05965aa7a
 SHA512:
-  metadata.gz: a9694514bb6710a41ab0a3331f9e9fdcbe0c36945304384e7b0b4207f93d323c1c65e10eed77cdbddaea566f325a2354918d43cbdf978d32224a57665826298e
-  data.tar.gz: 2e2b02f34e13133d93f70693670e423250aa16090165b87484eee2927dca52d48b791ef1ac7ec914aa87dd6aca09e4726942a2d55a23ddf198f2df2f74e90ac5
+  metadata.gz: 5e7aa4ab708794d3a80bd61158973cfdd38d9aec7af9b320811af6699137043ef4ce5372fb26c0e1493f4a0100b77356aae555d3228a3b819324a3c7e65853bc
+  data.tar.gz: 418c1f595998d385289b4825ebd181e1f2abdfe823b8d6ea33348f7b3c9c7adf771864cb94545fcead076b75ab4b2570dfea0a3519bb03e5000bca3f818189b1

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 Major changes for each release. Please see the Git log for complete list of changes.
 
+## 0.0.8
+
+* Don't preserve existing attributes when calling `expand!`.
+* Add User#orders method.
+
+## 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.

data/README.md

@@ -7,19 +7,16 @@ These classes provide simple read and write access to the Chord OMS API. Get sta
       api_key: '<key>'
     )
 
-    u = Chord::User.find(1)                   # fetch user
+    u = Chord::User.find(1)                   # fetch user by ID
     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.orders                                  # fetch the user's orders
     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 = Chord::Order.find('R87234695')        # fetch order by ID
     o.subscription_installment?               # was the order a subscription installment?
     o.subscription_start?                     # did the order start a subscription?
 
@@ -32,12 +29,10 @@ 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:
+You can also filter results by using `where`:
 
-    Chord::Order.where(
-      'q[completed_at_gt]' => '2022-09-14',
-       'q[s]' => 'completed_at desc'
-    )
+    Chord::Order.where('q[completed_at_gt]' => '2022-09-14')
+    Chord::User.where('q[spree_roles_id_in]' => 8)
 
 
 ## Object attributes
@@ -54,7 +49,7 @@ will return a Chord::Order object with around 40 attributes, not the full set of
 
 # Configuration options
 
-To get your sensitive config data out of your code, you can put it in a YAML file, like so:
+To get configuration data out of your code, put it in a YAML file, like so:
 
     # chord_config.yml
     base_url: https://...
@@ -64,7 +59,7 @@ and load it by calling:
 
     Chord.config_from_file('chord_config.yml')
 
-Or you can put your configuration in environment variables:
+Or put your config in environment variables:
 
     CHORD_BASE_URL=https://...
     CHORD_API_KEY=...
@@ -77,3 +72,8 @@ Both config-loading methods return a boolean indicating whether configuration da
 
     Chord.config_from_env or Chord.config_from_file('chord_config.yml')
 
+
+# To Do
+
+* tests should use mocks instead of real API requests
+* support more objects and methods

data/lib/chord/version.rb

@@ -1,3 +1,3 @@
 module Chord
-  VERSION = "0.0.6"
+  VERSION = "0.0.8"
 end

data/lib/chord.rb

@@ -45,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
@@ -85,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|
@@ -114,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
@@ -134,8 +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)
-      @attributes = all_attributes.merge(@attributes)
+      self.attributes = self.class.send(:fetch_attributes, id)
     end
 
     def method_missing(method, *args, &block)
@@ -150,36 +152,14 @@ module Chord
 
   class User < Base
 
-    #
-    # For avoiding API calls.
-    #
-    def self.all_by_id
-      unless @all_by_id
-        @all_by_id = {}
-        all.each do |u|
-          @all_by_id[u.id] = u
-        end
-      end
-      @all_by_id
-    end
-
-    #
-    # For mapping users on our old site to Chord.
-    #
-    def self.all_by_email
-      unless @all_by_email
-        @all_by_email = {}
-        all.each do |u|
-          @all_by_email[u.email] = u
-        end
-      end
-      @all_by_email
-    end
-
     def self.base_path
       'users'
     end
 
+    def orders
+      Order.where('q[user_id_eq]' => id)
+    end
+
     def add_role(role_id)
       self.class.put(base_url + "roles/#{role_id}/add/#{id}", http_options).parsed_response
     end
@@ -266,4 +246,17 @@ module Chord
       'products'
     end
   end
+
+  class Variant < Base
+
+    def self.base_path
+      'variants'
+    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.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2022-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty