wcc-data 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6ff0edbb218a416c3885bf1e8a028be54c8dfd6
+  data.tar.gz: 8304efad93290668fc1ae9022fcd1f4d90944989
+SHA512:
+  metadata.gz: bbc162507df12d2389a32348cf99ae1335345af81f5b12d919a0b7707159f586df1f1291887e1831e3b2e17dd4a95bcfea23ee0220f4ef51220c3ce8827bb9e6
+  data.tar.gz: 4f9fb68b42ccd76f8dec94a6fb6f97dd10c97a766529ef19c70a456a0bdb344a7076ff9fed15269d7071a929a35412d8747e6279e62fbb6f48cbfa9beb92acdb

data/.env.example

@@ -0,0 +1,3 @@
+NUCLEUS_CLIENT_ID=client-id-3
+NUCLEUS_CLIENT_SECRET=client-secret-3
+NUCLEUS_URL=http://login.dev/

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.env
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Travis Petticrew
+
+MIT License
+
+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,29 @@
+# Wcc::Data
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wcc-data'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wcc-data
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,36 @@
+require 'bundler/gem_tasks'
+require 'dotenv/tasks'
+
+PROJECT_PATH = File.dirname(__FILE__)
+LIB_PATH = File.join(PROJECT_PATH, "lib")
+
+task :default => :test
+
+desc 'run test examples'
+task :test do
+  exec 'rspec .'
+end
+
+task :environment => :dotenv do
+  $LOAD_PATH.unshift(LIB_PATH)
+  require 'wcc/data'
+end
+
+task :development => [:environment] do
+  WCC::Data.setup do |config|
+    conn = config.applications[:nucleus].connection
+    conn.use Faraday::Response::Logger
+    conn.basic_auth(ENV['NUCLEUS_CLIENT_ID'], ENV['NUCLEUS_CLIENT_SECRET'])
+  end
+end
+
+desc 'launch IRB shell with base environment loaded'
+task :irb => :environment do
+  require 'irb'
+  ARGV.clear
+  IRB.start
+end
+
+desc 'launch IRB shell with development environment loaded'
+task :console => [:development, :irb]
+

data/circle.yml

@@ -0,0 +1,6 @@
+machine:
+  ruby:
+    version: 2.2.0
+dependencies:
+  pre:
+    - cp .env.example .env

data/lib/wcc/data.rb

@@ -0,0 +1,26 @@
+require_relative "data/version"
+
+module WCC::Data
+
+  def self.config
+    @config ||= WCC::Data::Config.new
+  end
+
+  def self.setup
+    yield config
+  end
+
+end
+
+require_relative "data/config"
+require_relative "data/enumerated_type"
+require_relative "data/faraday_client_app_token_auth"
+require_relative "data/mapper"
+require_relative "data/model"
+require_relative "data/rack_client_app_token_auth"
+require_relative "data/response"
+require_relative "data/rest_endpoint"
+require_relative "data/service"
+
+require_relative "data/nucleus"
+

data/lib/wcc/data/config.rb

@@ -0,0 +1,45 @@
+require 'uri'
+require 'faraday'
+
+module WCC::Data
+  class Config
+    def initialize
+      set_default_applications
+    end
+
+    def applications
+      @applications ||= Hash.new { |hash, key| hash[key] = Application.new(key) }
+    end
+    alias :apps :applications
+
+    private
+
+    def set_default_applications
+      applications[:nucleus].uri = ENV['NUCLEUS_URL']
+      if ENV['APP_CLIENT_ID'] && ENV['APP_CLIENT_SECRET']
+        applications[:nucleus].connection
+          .basic_auth(ENV['APP_CLIENT_ID'], ENV['APP_CLIENT_SECRET'])
+      end
+    end
+
+    class Application
+      attr_reader :name, :uri
+      attr_accessor :connection
+
+      def initialize(name, connection: Faraday::Connection.new)
+        @name = name
+        @connection = connection
+      end
+
+      def uri=(uri)
+        @uri = URI(uri)
+      end
+
+      def service
+        Service.new(connection: connection, uri: uri)
+      end
+
+    end
+
+  end
+end

data/lib/wcc/data/enumerated_type.rb

@@ -0,0 +1,63 @@
+module WCC::Data
+  class EnumeratedType
+
+    def initialize(args={})
+      only_attributes(args).each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def self.[](value)
+      all.find { |record| record.matches?(value) }
+    end
+
+    def matches?(value)
+      raise NotImplementedError,
+        "The #matches? method should be defined in subclasses and return " \
+        "true if the argument matches this record and false otherwise."
+    end
+
+    def self.db
+      raise NotImplementedError,
+        "The ::db class method should be defined in subclasses as an array " \
+        "of hashes containing data for each record."
+    end
+
+    def self.all
+      @all ||= db.collect { |data| new(data) }
+    end
+
+    def self.reset
+      @all = nil
+    end
+
+    private
+
+    def only_attributes(args)
+      args.select { |key, value|
+        self.class.defined_attributes.include?(key)
+      }
+    end
+
+    def self.attributes(*attrs)
+      attrs.each do |attr|
+        defined_attributes << attr
+        define_method(attr) do
+          instance_variable_get("@#{attr}")
+        end
+      end
+    end
+
+    def self.defined_attributes
+      @attributes ||= []
+    end
+
+    def self.inherited(subclass)
+      subclass.send(
+        :instance_variable_set,
+        :@attributes,
+        defined_attributes.dup
+      )
+    end
+  end
+end

data/lib/wcc/data/faraday_client_app_token_auth.rb

@@ -0,0 +1,64 @@
+module WCC::Data
+  class FaradayClientAppTokenAuth < Faraday::Middleware
+    class RedisCache
+      DEFAULT_CACHE_KEY = "org.watermark.data.client-app-token-cache-store"
+      attr_reader :connection, :cache_key
+
+      def initialize(connection, cache_key: DEFAULT_CACHE_KEY)
+        @connection = connection
+        @cache_key = cache_key
+      end
+
+      def [](hostname)
+        connection.call { |r| r.hget cache_key, hostname }
+      end
+
+      def []=(hostname, token)
+        if token
+          connection.call { |r| r.hset cache_key, hostname, token }
+        else
+          connection.call { |r| r.hdel cache_key, hostname }
+        end
+      end
+    end
+
+    attr_reader :cache, :token_factory
+
+    def initialize(app, cache: default_cache, token_factory: method(:default_token_factory))
+      super(app)
+      @cache = cache
+      @token_factory = token_factory
+    end
+
+    def token_for(host)
+      @cache[host] ||= token_factory.(host)
+    end
+
+    def call(env, retry_on_forbidden: true)
+      request_body = env[:body]
+      host = env[:url].host
+      env[:request_headers]["Authorization"] = "Bearer #{token_for(host)}"
+      @app.call(env).on_complete do |response_env|
+        response = Faraday::Response.new(response_env)
+        cache[host] = nil unless response.success?
+        if response.status == 403 && retry_on_forbidden
+          env[:body] = request_body
+          call(env, retry_on_forbidden: false)
+        end
+      end
+    end
+
+    private
+
+    def default_token_factory(host)
+      WCC::Data::Nucleus::ClientAppToken.create(hostname: host).token
+    end
+
+    def default_cache
+      RedisCache.new(Sidekiq.method(:redis))
+    end
+  end
+end
+
+Faraday::Middleware.register_middleware :client_app_token => lambda { WCC::Data::FaradayClientAppTokenAuth }
+

data/lib/wcc/data/mapper.rb

@@ -0,0 +1,16 @@
+module WCC::Data
+
+  module Mapper
+    class MapperError < StandardError; end
+    class EndpointUndefined < MapperError; end
+    class InvalidResponse < MapperError; end
+    class RecordNotFound < MapperError; end
+  end
+
+end
+
+require_relative "mapper/attributes"
+require_relative "mapper/json_response"
+require_relative "mapper/rest_configuration"
+require_relative "mapper/rest_query"
+

data/lib/wcc/data/mapper/attributes.rb

@@ -0,0 +1,54 @@
+module WCC::Data::Mapper
+
+  module Attributes
+
+    def self.included(receiver)
+      receiver.send(:include, InstanceMethods)
+      receiver.extend(ClassMethods)
+    end
+
+    module InstanceMethods
+      attr_reader :attributes
+
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      def [](attribute)
+        self.class.attributes.fetch(attribute.to_s) {
+          raise KeyError, "The attribute #{attribute} is not defined"
+        }
+        @attributes[attribute.to_s]
+      end
+
+      def []=(attribute, value)
+        self.class.attributes.fetch(attribute.to_s) {
+          raise KeyError, "The attribute #{attribute} is not defined"
+        }
+        @attributes[attribute.to_s] = value
+      end
+
+    end
+
+    module ClassMethods
+
+      def attribute(name, options={})
+        attributes[name.to_s] = options.freeze
+        define_method(name) { self[name] }
+        define_method("#{name}=") { |val| self[name] = val } if options[:writer]
+      end
+
+      def attributes
+        @attributes ||= {}
+      end
+
+      def inherited(subclass)
+        super
+        subclass.instance_variable_set(:@attributes, attributes.dup)
+      end
+
+    end
+
+  end
+
+end

data/lib/wcc/data/mapper/json_response.rb

@@ -0,0 +1,20 @@
+module WCC::Data::Mapper
+
+  module JSONResponse
+
+    def new_from_response(response)
+      raise RecordNotFound if response.status == 404
+      case response.json
+      when Array
+        response.json.collect { |obj| new(obj) }
+      when Hash
+        new(response.json)
+      else
+        raise InvalidResponse, "Cannot build object from response!"
+      end
+    end
+
+  end
+
+end
+

data/lib/wcc/data/mapper/rest_configuration.rb

@@ -0,0 +1,36 @@
+module WCC::Data::Mapper
+
+  module RESTConfiguration
+
+    def set_endpoint(app_name, uri)
+      @endpoint_config = {
+        app: app_name,
+        uri: uri,
+      }
+    end
+
+    def endpoint_config
+      @endpoint_config ||= {}
+    end
+
+    def endpoint
+      @endpoint = WCC::Data::RESTEndpoint.new(
+        service: service_from_app_name(endpoint_config[:app]).merge(uri: endpoint_config[:uri])
+      )
+    end
+
+    def inherited(subclass)
+      super
+      subclass.instance_variable_set(:@endpoint_config, endpoint_config.dup)
+    end
+
+    private
+
+    def service_from_app_name(app_name)
+      WCC::Data.config.applications[app_name].service
+    end
+
+  end
+
+end
+