pupper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '0290fefffb2e32822798c08c308a923748e6401c'
+  data.tar.gz: e599fee355ab08a376567c4adfea8817d60565bb
+SHA512:
+  metadata.gz: 46a4bdb94f785741e88964ed7d64c3620c0ccb9e74f2d94a964eb7538af62461c0cbc4f558094979b72c43c083aab3efa5e2ffc0f00aa754d6d58967c8f7ed58
+  data.tar.gz: b92a2e1245d5d0a112bf53f53a3d39e815aab35aacaa6ab8912be0ce751374ca33965ea177bdc1afc8bbace7b58be2a665d8368c051df21366b0d73386126790

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pupper.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Lee Machin
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Lee Machin
+
+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,41 @@
+# Pupper
+
+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/pupper`. 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 'pupper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pupper
+
+## 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/Lee Machin/pupper.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "pupper"
+
+# 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/pupper/api_associations.rb

@@ -0,0 +1,82 @@
+module Pupper
+  module ApiAssociations
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def associations
+        @associations ||= { has_one: [], has_many: [] }
+      end
+
+      def has_one(assoc)
+        associations[:has_one] << assoc
+      end
+
+      def has_many(assoc)
+        associations[:has_many] << assoc
+      end
+    end
+
+    included do
+      private
+
+      delegate :associations, to: :class
+      attr_reader :excluded_attrs
+
+      def build_associations(assocs)
+        assocs.each_with_object({}) do |(name, value), memo|
+          name = name.to_s
+          foreign_key = name.slice!(/_u?id/)&.[](1..-1)&.to_sym
+          name = name.to_sym
+
+          create_assoc_model(memo, name, foreign_key, value)
+        end
+      end
+
+      def create_attribute(name, foreign_key = nil, value = nil)
+        self.class.attr_accessor(name)
+
+        return unless foreign_key.present?
+
+        excluded_attrs << name if foreign_key.present?
+        send("#{name}_#{foreign_key}=", value)
+      end
+
+      def find_assoc_type(name)
+        associations
+          .find { |(_, assoc)| assoc.include?(name) }&.first
+      end
+
+      def create_has_one_assoc_model(name, foreign_key, value)
+        create_attribute(name, foreign_key, value)
+        model = "#{self.class.parent}/#{name}".classify.constantize
+
+        if foreign_key
+          model.new(foreign_key => value)
+        else
+          model.new(value)
+        end
+      end
+
+      def create_has_many_assoc_model(name, values)
+        create_attribute(name)
+        values.map(&name.constantize)
+      end
+
+      def create_assoc_model(assocs, name, foreign_key, value)
+        case find_assoc_type(name)
+        when :has_one
+          assocs[name] = create_has_one_assoc_model(name, foreign_key, value)
+        when :has_many
+          assocs[name] = create_has_many_assoc_model(name, value)
+        else
+          Rails.logger.warn("Try to use an association for #{name} in #{model_name.name}!")
+          assocs[:"#{name}_#{foreign_key}"] = value
+        end
+      end
+
+      def excluded_attrs
+        @excluded_attrs ||= []
+      end
+    end
+  end
+end

data/lib/pupper/auditable.rb

@@ -0,0 +1,64 @@
+module Pupper
+  module Auditable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def audit(*methods)
+        underlying_methods = ''
+
+        methods.each do |meth|
+          underlying_methods << <<-RB.strip_heredoc
+            def #{meth}
+              audit { super }
+              changes_applied
+            end
+          RB
+        end
+
+        prepend Module.new { module_eval(underlying_methods, __FILE__, __LINE__) }
+      end
+    end
+
+    included do
+      extend ActiveModel::Callbacks
+
+      define_model_callbacks :update, only: :after
+      after_update :create_audit_log
+
+      def audit(&block)
+        run_callbacks :update, &block
+        changes_applied
+      end
+
+      def audit_logs
+        AuditLog.where(auditable_type: model_name.name, auditable_id: primary_key)
+      end
+
+      def create_audit_log
+        return unless changed?
+
+        audit_model.create(
+          auditable_type: model_name.name,
+          auditable_id: primary_key,
+          user: Pupper.config.current_user,
+          what_changed: changes
+        )
+      end
+
+      def update_attributes(**attrs)
+        run_callbacks(:update) do
+          assign_attributes(**attrs)
+          backend.update(self)
+        end
+
+        changes_applied
+      end
+
+      private
+
+      def audit_model
+        @audit_model ||= Pupper.config.audit_with.to_s.classify.constantize
+      end
+    end
+  end
+end

data/lib/pupper/backend.rb

@@ -0,0 +1,52 @@
+require 'pupper/parse_json'
+
+module Pupper
+  class Backend
+    class BaseUrlNotDefined < StandardError; end
+
+    attr_reader :client, :model
+
+    delegate :base_url, to: :class
+
+    class << self
+      attr_writer :base_url
+
+      def base_url
+        if @base_url.nil?
+          raise BaseUrlNotDefined, <<-ERR
+            Add the following to #{name} to make it work:
+
+              self.base_url = "https://example.com/some/path"
+
+            Making sure to change the URL to something useful :)))
+          ERR
+        end
+
+        @base_url
+      end
+    end
+
+    %i(get put post delete patch).each do |name|
+      class_eval <<-RB.strip_heredoc, __FILE__, __LINE__
+        def #{name}(*args)
+          client.send(:#{name}, *args).body
+        end
+      RB
+    end
+
+    def initialize
+      @client = Faraday.new(base_url, ssl: { verify: Rails.env.production? }) do |builder|
+        builder.request :json
+        builder.use Pupper::ParseJson
+        builder.response :logger if Rails.env.development?
+        builder.response :raise_error
+        builder.adapter :typhoeus
+        builder.headers['User-Agent'] = Pupper.config.user_agent
+      end
+    end
+
+    def register_model(model)
+      @model = model
+    end
+  end
+end

data/lib/pupper/model.rb

@@ -0,0 +1,71 @@
+require 'pupper/api_associations'
+require 'pupper/auditable'
+require 'pupper/trackable_attributes'
+
+module Pupper
+  module Model
+    extend ActiveSupport::Concern
+
+    class NoSuchBackend < NameError; end
+
+    included do
+      include ActiveModel::Model
+      include ActiveModel::Serializers::JSON
+
+      include Pupper::Auditable
+      include Pupper::TrackableAttributes
+      include Pupper::ApiAssociations
+
+      delegate :backend, to: :class
+
+      def initialize(**args)
+        assocs, attrs = args.partition do |attr, value|
+          attr.to_s =~ /_u?id$/ || value.is_a?(Hash)
+        end.map(&Hash.method(:[]))
+
+        assocs = build_associations(assocs)
+
+        super(**attrs, **assocs)
+
+        changes_applied
+
+        backend.register_model(self)
+      end
+
+      def primary_key
+        send(self.class.primary_key)
+      end
+    end
+
+    class_methods do
+      attr_writer :primary_key, :backend
+
+      def primary_key
+        @primary_key ||= :uid
+      end
+
+      def backend
+        @backend ||= "#{model_name.name.pluralize}Client".constantize.new
+      rescue NameError
+        raise NoSuchBackend, <<-ERR
+          Model #{model_name.name} is looking for an API client that doesn't exist!
+
+          Either a) implement the new client:
+
+            # app/api_clients/#{model_name.name.sub('::', '/').downcase.pluralize}_client.rb
+            class #{model_name.name.pluralize}Client < Pupper::Backend
+            end
+
+          Or b) use a different client instead
+
+            self.backend = Other::BackendClient
+
+        ERR
+      end
+    end
+
+    def to_json(*)
+      attributes.except(*excluded_attrs).to_json
+    end
+  end
+end

data/lib/pupper/parse_json.rb

@@ -0,0 +1,7 @@
+module Pupper
+  class ParseJson < FaradayMiddleware::ParseJson
+    define_parser do |body|
+      Oj.load(body, symbol_keys: true) unless body.strip.empty?
+    end
+  end
+end

data/lib/pupper/trackable_attributes.rb

@@ -0,0 +1,59 @@
+module Pupper
+  module TrackableAttributes
+    def self.included(base)
+      base.send :include, ActiveModel::Dirty
+      base.send :include, InstanceMethods
+
+      class << base
+        prepend ClassMethods
+      end
+    end
+
+    module InstanceMethods
+      def attributes
+        @attributes ||= {}
+      end
+
+      def reload!
+        restore_attributes
+      end
+
+      def rollback!
+        restore_attributes
+      end
+
+      def refresh(**attrs)
+        assign_attributes(**attrs)
+        changes_applied
+      end
+    end
+
+    module ClassMethods
+      def _attributes
+        @_attributes ||= []
+      end
+
+      def _attributes=(attrs)
+        @_attributes = attrs
+      end
+
+      def attr_accessor(*attrs)
+        # override the default so that we can hook into the created methods
+        define_attribute_methods(*attrs)
+
+        _attributes << attrs
+
+        attrs.each do |attr|
+          define_method attr do
+            attributes[attr]
+          end
+
+          define_method "#{attr}=" do |value|
+            send("#{attr}_will_change!") unless value == send(attr)
+            attributes[attr] = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pupper/version.rb

@@ -0,0 +1,3 @@
+module Pupper
+  VERSION = "0.1.0"
+end

data/lib/pupper.rb

@@ -0,0 +1,30 @@
+require 'active_support/all'
+require 'active_model'
+require 'faraday'
+require 'faraday_middleware'
+require 'oj'
+require 'typhoeus/adapters/faraday'
+
+require 'pupper/version'
+require 'pupper/backend'
+require 'pupper/model'
+
+module Pupper
+
+  mattr_accessor :config
+
+  def self.configure
+    self.config ||= Config.new
+    yield self.config
+  end
+
+  class Config
+    attr_accessor :audit_with, :user_agent
+    thread_mattr_accessor :current_user
+
+    def initialize
+      @audit_with = :audit_log
+      @user_agent = "pupper (v: #{Pupper::VERSION})"
+    end
+  end
+end

data/pupper.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pupper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pupper'
+  spec.version       = Pupper::VERSION
+  spec.authors       = ['Lee Machin']
+  spec.email         = ['lee@typeform.com']
+  spec.summary       = 'Interact with APIs as if they were ActiveRecord models.'
+  spec.homepage      = 'https://github.com/leemachin/pupper'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency 'activesupport', '~> 5.0'
+  spec.add_dependency 'activemodel', '~> 5.0'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'typhoeus'
+  spec.add_dependency 'oj'
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: pupper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lee Machin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- lee@typeform.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pupper.rb
+- lib/pupper/api_associations.rb
+- lib/pupper/auditable.rb
+- lib/pupper/backend.rb
+- lib/pupper/model.rb
+- lib/pupper/parse_json.rb
+- lib/pupper/trackable_attributes.rb
+- lib/pupper/version.rb
+- pupper.gemspec
+homepage: https://github.com/leemachin/pupper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Interact with APIs as if they were ActiveRecord models.
+test_files: []