zaius 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57b238d3a6ff59579af7036c014514c77170ab67e15060d602fd5e46c3df2178
+  data.tar.gz: 49536b0b47debd6fd4a458eab4eaeb36932264e832d4def12cc8f0bb00b7ade7
+SHA512:
+  metadata.gz: 16108b1f95352dc7c8a072586e685fa6d6f00f035790789d9f7415722c08f174e97f6fb87d04244f64fc61b1fd9527577ce6d9b284e991533787ee579908bd0c
+  data.tar.gz: e2f9e007d7627f79f454fc71e093ef69690c9b1d2b994abef402e4e2635cea7240ad36c7e2c7d23115b8a5e8a156216e6acc338c0395b896c8b6410ba2185e7c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in zaius.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    zaius (0.1.0)
+      faraday (~> 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    faraday (0.15.3)
+      multipart-post (>= 1.2, < 3)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  zaius!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Chris Anderson
+
+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,39 @@
+# Zaius
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/zaius`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zaius'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zaius
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chrismanderson/zaius.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zaius"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/zaius/api_operations/list.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Zaius
+  module APIOperations
+    module List
+      def list(filters = {}, opts = {})
+        resp, opts = request(:get, resource_url, filters, opts)
+        obj = ListObject.construct_from(resp.data, opts)
+
+        obj
+      end
+    end
+  end
+end

data/lib/zaius/api_operations/request.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Zaius
+  module APIOperations
+    module Request
+      module ClassMethods
+        def request(method, url, params = {}, opts = {})
+          opts[:client] ||= ZaiusClient.active_client
+
+          headers = opts.clone
+          api_key = headers.delete(:api_key)
+          api_base = headers.delete(:api_base)
+          client = headers.delete(:client)
+          # Assume all remaining opts must be headers
+
+          resp, opts[:api_key] = client.execute_request(
+            method, url,
+            api_base: api_base, api_key: api_key,
+            headers: headers, params: params
+          )
+
+          # Hash#select returns an array before 1.9
+          opts_to_persist = {}
+
+          [resp, opts_to_persist]
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      protected
+
+      def request(method, url, params = {}, opts = {})
+        opts = @opts.merge(Util.normalize_opts(opts))
+        self.class.request(method, url, params, opts)
+      end
+    end
+  end
+end

data/lib/zaius/api_resource.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Zaius
+  class APIResource < ZaiusObject
+    include Zaius::APIOperations::Request
+
+    def self.class_name
+      name.split("::")[-1]
+    end
+
+    def self.resource_url
+      if self == APIResource
+        raise NotImplementedError, "APIResource is an abstract class.  You should perform actions on its subclasses (Charge, Customer, etc.)"
+      end
+      # Namespaces are separated in object names with periods (.) and in URLs
+      # with forward slashes (/), so replace the former with the latter.
+      "/#{self::OBJECT_NAME.downcase.tr('.', '/')}s"
+    end
+
+    # A metaprogramming call that specifies that a field of a resource can be
+    # its own type of API resource (say a nested card under an account for
+    # example), and if that resource is set, it should be transmitted to the
+    # API on a create or update. Doing so is not the default behavior because
+    # API resources should normally be persisted on their own RESTful
+    # endpoints.
+    def self.save_nested_resource(name)
+      define_method(:"#{name}=") do |value|
+        super(value)
+
+        # The parent setter will perform certain useful operations like
+        # converting to an APIResource if appropriate. Refresh our argument
+        # value to whatever it mutated to.
+        value = send(name)
+
+        # Note that the value may be subresource, but could also be a scalar
+        # (like a tokenized card's ID for example), so we check the type before
+        # setting #save_with_parent here.
+        value.save_with_parent = true if value.is_a?(APIResource)
+
+        value
+      end
+    end
+
+    def resource_url
+      unless (id = self["id"])
+        raise InvalidRequestError.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}", "id")
+      end
+      "#{self.class.resource_url}/#{CGI.escape(id)}"
+    end
+
+    def refresh
+      resp, opts = request(:get, resource_url, @retrieve_params)
+      initialize_from(resp.data, opts)
+    end
+
+    def self.retrieve(id, opts = {})
+      opts = Util.normalize_opts(opts)
+      instance = new(id, opts)
+      instance.refresh
+      instance
+    end
+  end
+end

data/lib/zaius/customer.rb

@@ -0,0 +1,9 @@
+module Zaius
+  class Customer < APIResource
+    OBJECT_NAME = "customer".freeze
+
+    def resource_url
+      "/profiles"
+    end
+  end
+end

data/lib/zaius/errors.rb

@@ -0,0 +1,44 @@
+module Zaius
+  class ZaiusError < StandardError
+
+    attr_reader :code
+    attr_reader :http_body
+    attr_reader :http_headers
+    attr_reader :http_status
+    attr_reader :json_body # equivalent to #data
+
+    attr_accessor :response
+
+    def initialize(message = nil, http_status: nil, http_body: nil, json_body: nil,
+                   http_headers: nil, code: nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @http_headers = http_headers || {}
+      @json_body = json_body
+      @code = code
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+
+  class APIError < ZaiusError
+    def initialize(title:, http_status: nil, detail: {})
+      @message = title
+      @http_status = http_status
+
+      @json_body = detail
+
+      def to_s
+        status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+        "#{status_string}#{@message}: #{json_body}"
+      end
+    end
+  end
+
+  class AuthenticationError < StandardError
+  end
+end

data/lib/zaius/list.rb

@@ -0,0 +1,7 @@
+module Zaius
+  class List < APIResource
+    extend Zaius::APIOperations::List
+
+    OBJECT_NAME = "list".freeze
+  end
+end

data/lib/zaius/list_object.rb

@@ -0,0 +1,56 @@
+module Zaius
+  class ListObject < ZaiusObject
+    include Enumerable
+    include Zaius::APIOperations::List
+    include Zaius::APIOperations::Request
+    # include Zaius::APIOperations::Create
+
+    OBJECT_NAME = "list".freeze
+
+    # This accessor allows a `ListObject` to inherit various filters that were
+    # given to a predecessor. This allows for things like consistent limits,
+    # expansions, and predicates as a user pages through resources.
+    attr_accessor :filters
+
+    # An empty list object. This is returned from +next+ when we know that
+    # there isn't a next page in order to replicate the behavior of the API
+    # when it attempts to return a page beyond the last.
+    def self.empty_list(opts = {})
+      ListObject.construct_from({ data: [] }, opts)
+    end
+
+    def initialize(*args)
+      super
+      self.filters = {}
+    end
+
+    def [](k)
+      case k
+      when String, Symbol
+        super
+      else
+        raise ArgumentError, "You tried to access the #{k.inspect} index, but ListObject types only support String keys. (HINT: List calls return an object with a 'data' (which is the data array). You likely want to call #data[#{k.inspect}])"
+      end
+    end
+
+    # Iterates through each resource in the page represented by the current
+    # `ListObject`.
+    #
+    # Note that this method makes no effort to fetch a new page when it gets to
+    # the end of the current page's resources. See also +auto_paging_each+.
+    def each(&blk)
+      data.each(&blk)
+    end
+
+    def retrieve(id, opts = {})
+      id, retrieve_params = Util.normalize_id(id)
+      resp, opts = request(:get, "#{resource_url}/#{CGI.escape(id)}", retrieve_params, opts)
+      Util.convert_to_zaius_object(resp.data, opts)
+    end
+
+    def resource_url
+      url ||
+        raise(ArgumentError, "List object does not contain a 'url' field.")
+    end
+  end
+end

data/lib/zaius/subscription.rb

@@ -0,0 +1,59 @@
+module Zaius
+  class Subscription < APIResource
+    OBJECT_NAME = "subscription".freeze
+
+    def self.resource_url
+      "/lists/subscriptions"
+    end
+
+    def self.list(params = {}, opts = {})
+      resp, opts = request(:get, resource_url, params, opts)
+
+      ZaiusObject.construct_from(resp.data, opts)
+    end
+
+    def self.update_opt_in(params = {}, opts = {})
+      resp, opts = request(:post, resource_url, params, opts)
+
+      ZaiusObject.construct_from(resp.data, opts)
+    end
+
+    def self.update(email: nil, list_id: nil, subscribed: false)
+      params = { email: email, list_id: list_id, subscribed: subscribed }
+      resp, opts = request(:post, resource_url, params)
+
+      ZaiusObject.construct_from(resp.data, opts)
+    end
+
+    def self.update_list(opted_in: true, email:, lists: [])
+      body = lists.map do |list|
+        [
+          { opted_in: opted_in, email: email },
+          { list_id: list[:id], email: email, subscribed: list[:subscribed] }
+        ]
+      end.flatten
+      resp, opts = request(:post, resource_url, body)
+
+      ZaiusObject.construct_from(resp.data, opts)
+    end
+
+    def self.opt_out(params = {}, opts = {})
+      params[:opted_in] = false
+      resp, opts = request(:post, resource_url, params, opts)
+
+      ZaiusObject.construct_from(resp.data, opts)
+    end
+
+    def self.opt_in(params = {}, opts = {})
+      params[:opted_in] = true
+
+      resp, opts = request(:post, resource_url, params, opts)
+
+      ZaiusObject.construct_from(resp.data, opts)
+    end
+
+    def resource_url
+      self.class.resource_url
+    end
+  end
+end