chord 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4caa956b7d9f279a1973f2a5ad5e63f0078697ecb1fc129fcff09c10dfcdbbc3
-  data.tar.gz: c4a93aa0e26f11d6bb42b7345b1dead92f685eafb43d96fa34516d05eb3a09a2
+  metadata.gz: 8e83b6981808cf5864784c21d0558273fa3edc0099f43d495ef06d556c36f08e
+  data.tar.gz: 8b4a00fc5b097a03b527097350fab0f38ed21871f5279e2a58d9fef58dc60b80
 SHA512:
-  metadata.gz: 8fa44ce53bc77f079140bab0838a66196314f103f3c515ea8dd90c9341af047fa5afb19925189a864652590d4fcf2f431095ceb4cbbde99725085dd72477206e
-  data.tar.gz: f30e7aa9d991c7822ab93777a8a6de9c9f6df943a83d8bf7c629a2b1f3ba18bc485d570a2aa152ca14f2e01d6b3e794925d1cf931199ad76f78a3ddb868b9feb
+  metadata.gz: 28c212e87eb22ea7a0fa807949ecd0470154abc16761d1847411cb9d516518febaf0da6e754558895e13fd7ecf0cd4660685a6593b9b554549cc3b87ed28d2a6
+  data.tar.gz: 9e84d6c2edf9cb3526184f13121099e3ecd8ee9412b5563a311c41f2910d09b229b7f5de1c10ca215fd5274b48a46114aba8221430bb1700818862bc35f41072

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 Major changes for each release. Please see the Git log for complete list of changes.
 
+## 0.0.9
+
+* When API error on update, don't update object attributes.
+
+## 0.0.8
+
+* Don't preserve existing attributes when calling `expand!`.
+* Add User#orders method.
+
 ## 0.0.7
 
 * Remove ActiveRecord dependency.

data/README.md

@@ -7,15 +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
 
-    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?
 
@@ -28,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
@@ -50,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://...
@@ -60,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 +76,4 @@ Both config-loading methods return a boolean indicating whether configuration da
 # 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.7"
+  VERSION = "0.0.9"
 end

data/lib/chord.rb

@@ -125,9 +125,14 @@ module Chord
     end
 
     def update(new_attributes)
-      self.attributes = self.class.patch(base_url + "#{base_path}/#{id}",
+      response = self.class.patch(base_url + "#{base_path}/#{id}",
         http_options.merge(body: new_attributes.to_json)
       ).parsed_response
+      if response.include?('error')
+        raise APIError, "Chord API error (status #{response['status']}): #{response['error']}"
+      else
+        self.attributes = response
+      end
     end
 
     def delete
@@ -137,8 +142,7 @@ module Chord
     # fetch all attributes, but don't overwrite existing ones,
     # in case changes have been made
     def expand!
-      all_attributes = self.class.send(:fetch_attributes, id)
-      @attributes = all_attributes.merge(@attributes)
+      self.attributes = self.class.send(:fetch_attributes, id)
     end
 
     def method_missing(method, *args, &block)
@@ -153,36 +157,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
@@ -270,6 +252,13 @@ module Chord
     end
   end
 
+  class Variant < Base
+
+    def self.base_path
+      'variants'
+    end
+  end
+
   class ConfigurationError < StandardError
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chord
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2022-09-26 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.5.0
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="