chord 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82b29351f996510a42975aa338c2ece2744e49780e4c31b2c265593a2707824c
-  data.tar.gz: 7bc61180788440328b85083997629d9d63ddf7496c2a5702869973a6ca4ce238
+  metadata.gz: 4caa956b7d9f279a1973f2a5ad5e63f0078697ecb1fc129fcff09c10dfcdbbc3
+  data.tar.gz: c4a93aa0e26f11d6bb42b7345b1dead92f685eafb43d96fa34516d05eb3a09a2
 SHA512:
-  metadata.gz: a9694514bb6710a41ab0a3331f9e9fdcbe0c36945304384e7b0b4207f93d323c1c65e10eed77cdbddaea566f325a2354918d43cbdf978d32224a57665826298e
-  data.tar.gz: 2e2b02f34e13133d93f70693670e423250aa16090165b87484eee2927dca52d48b791ef1ac7ec914aa87dd6aca09e4726942a2d55a23ddf198f2df2f74e90ac5
+  metadata.gz: 8fa44ce53bc77f079140bab0838a66196314f103f3c515ea8dd90c9341af047fa5afb19925189a864652590d4fcf2f431095ceb4cbbde99725085dd72477206e
+  data.tar.gz: f30e7aa9d991c7822ab93777a8a6de9c9f6df943a83d8bf7c629a2b1f3ba18bc485d570a2aa152ca14f2e01d6b3e794925d1cf931199ad76f78a3ddb868b9feb

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 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.

data/README.md

@@ -14,10 +14,6 @@ These classes provide simple read and write access to the Chord OMS API. Get sta
     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?
@@ -77,3 +73,7 @@ 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

data/lib/chord/version.rb

@@ -1,3 +1,3 @@
 module Chord
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 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,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
 
@@ -266,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.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-21 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:
   - - ">="