chord 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ecdb151eb16d8e1187e7ae8a6bf59cd57895580ba5c578fd166ed5b2c795da16
+  data.tar.gz: 33bb400c1a6c0f6df638125ebc86d6fa54f513075e994756e71daf72a1cc198d
+SHA512:
+  metadata.gz: cac1d8dfeb749f6e8e5e12776031973755f73e4976ed6bb4505fc464eb92b43942cffed3251ccb34d9013fbfab3ee4b32648c257107bac885b90e11231a27810
+  data.tar.gz: 1c95d655de397bd5b0d88c46d924ce8dbdd760bde3e17a16a38bf4dc7c262a8127a7f662ab9eacd5eb91315a5b9645cbea918a09a040eb0df281846f7ed5ab20

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+Major changes for each release. Please see the Git log for complete list of changes.
+
+## 0.0.1
+
+* Very rudimentary start, focused on the parts of the API I need to use.
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2021 Alex Reisner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# Chord OMS
+
+These classes provide simple read and write access to the Chord OMS API. Get started like this:
+
+    CHORD_API_CONFIG = {
+      staging: {
+        base_url: 'https://<customer>.staging.assembly-api.com/api/',
+        api_key: '<key>'
+      },
+      production: {
+        base_url: 'https://<customer>.assembly-api.com/api/',
+        api_key: '<key>'
+      }
+    }
+
+    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.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
+
+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
+
+will return a Chord::User object with only two attributes (ID and email) because the API only returns two attributes with a Subscription object.
+

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'chord'
+
+if File.exist?('config.yml')
+  require 'yaml'
+  CHORD_API_CONFIG = YAML.load(File.read('config.yml'), symbolize_names: true)
+end
+
+require 'irb'
+IRB.start

data/lib/chord/version.rb

@@ -0,0 +1,3 @@
+module Chord
+  VERSION = "0.0.1"
+end

data/lib/chord.rb

@@ -0,0 +1,201 @@
+require 'httparty'
+
+module Chord
+
+  class << self
+    attr_writer :env
+    def env; @env || :staging; end # :staging by default
+  end
+
+  class Base
+    include HTTParty
+
+    class << self
+      attr_writer :per_page
+      def per_page; @per_page || 99999; end
+    end
+
+    def self.base_url
+      CHORD_API_CONFIG[Chord.env][:base_url]
+    end
+
+    def self.find(id)
+      attrs = get(base_url + "#{base_path}/#{id}", http_options).parsed_response
+      new(id, attrs)
+    end
+
+    def self.fetch_all_data(query_options = {})
+      query_options = {
+        per_page: per_page
+      }.merge(query_options)
+      get(base_url + "#{base_path}?#{hash_to_query(query_options)}", http_options).parsed_response
+    end
+
+    def self.all(query_options = {})
+      @all ||= fetch_all_data(query_options)[base_path].map{ |i| new(i['id'], i) }
+    end
+
+    def self.http_options
+      {headers: {
+        'Authorization' => "Bearer #{CHORD_API_CONFIG[Chord.env][:api_key]}",
+        'Content-Type' => 'application/json'
+      }}
+    end
+
+    def self.hash_to_query(hash)
+      require 'cgi' unless defined?(CGI) && defined?(CGI.escape)
+      hash.collect{ |p|
+        p[1].nil? ? nil : p.map{ |i| CGI.escape i.to_s } * '='
+      }.compact.sort * '&'
+    end
+
+    def base_url
+      self.class.base_url
+    end
+
+    def base_path
+      self.class.base_path
+    end
+
+    def http_options
+      self.class.http_options
+    end
+
+    attr_reader :id
+    attr_accessor :attributes
+
+    def initialize(id, attributes = {})
+      @id = id
+      @attributes = attributes
+    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
+    end
+
+    def delete
+      self.class.delete(base_url + "#{base_path}/#{id}", http_options).parsed_response
+    end
+
+    def method_missing(method, *args, &block)
+      if attributes.include?(method.to_s)
+        attributes[method.to_s]
+      else
+        super
+      end
+    end
+  end
+
+
+  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 add_role(role_id)
+      self.class.put(base_url + "roles/#{role_id}/add/#{id}", http_options).parsed_response
+    end
+
+    def remove_role(role_id)
+      self.class.put(base_url + "roles/#{role_id}/remove/#{id}", http_options).parsed_response
+    end
+
+    def subscriptions
+      self.class.get(base_url + "users/#{id}/subscriptions", http_options).parsed_response['subscriptions'].map{ |s| Chord::Subscription.new(s['id'], s) }
+    end
+
+    def find_subscription(subscription_id)
+      self.class.get(base_url + "users/#{id}/subscriptions/#{subscription_id}", http_options).parsed_response
+    end
+  end
+
+
+  class Order < Base
+
+    def self.base_path
+      'orders'
+    end
+
+    def user
+      Chord::User.find(attributes['user_id'])
+    end
+
+    def payments
+      self.class.get(base_url + "orders/#{id}/payments", http_options).parsed_response['payments'].map{ |p| Chord::Payment.new(p['id'], p) }
+    end
+
+    def create_adjustment(order_id, label, discount)
+      attributes = {
+        label: label,
+        discount_by: discount
+      }
+      self.class.post(base_url + "hub/orders/#{order_id}/adjustments",
+        http_options.merge(body: attributes.to_json)
+      ).parsed_response
+    end
+  end
+
+
+  class Role < Base
+
+    def self.base_path
+      'roles'
+    end
+  end
+
+
+  class Subscription < Base
+
+    def user
+      u = attributes['user']
+      Chord::User.new(u['id'], u)
+    end
+  end
+
+  class Payment < Base
+  end
+
+  class Product < Base
+
+    def self.base_path
+      'products'
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: chord
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Reisner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+description: ActiveRecord-like syntax. Still in alpha-stage early development. Many
+  endpoints and features not yet supported. Some bugs.
+email:
+- alex@alexreisner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/console
+- lib/chord.rb
+- lib/chord/version.rb
+homepage: https://www.github.com/alexreisner/chord
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/alexreisner/chord
+  changelog_uri: https://github.com/alexreisner/chord/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Easy access to Chord Commerce API.
+test_files: []