wcc-data 0.3.9 → 0.4.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39ee71b24991611f222411ff406d9d5b8bda3f0b
-  data.tar.gz: 38c06caa2ebd8c97866dc5fdacdfe40c1140ed41
+  metadata.gz: 82f9b734e798bdb01d28323037ba25ea1a87a831
+  data.tar.gz: 46b3020ff169cdfa6e687c9933b765a5f7ed26a6
 SHA512:
-  metadata.gz: 7dabe6eed115fcd58fd4c6b0c450b4caa70ba8778a2c14ffdff4eb0ecfc2dcb21b65259763a3ccc6e4805d2066c230073d56faabea8836a1ac82228aedf4e1f7
-  data.tar.gz: 187c70f79ed1b2e9251f37d3d42efa032a5ce38aaef61aabc9df5232eb623be361630a398c123090f06212bab81152b8141fd7edd4cc87f4806d29b12d76a6ff
+  metadata.gz: b527b25651b9e1e0930ba6c0f4c4b816e929b9efc664910d1b5dd7ce42936840f2b1ab46e1489654c05490a145426bf3121fb9efd236e4cf03d4d596f8f582d5
+  data.tar.gz: 4cf4c852f51a72b46ff553539a72903ef218e314eaafe70651b6945c587efececd064e0f222f2508ba75e6825884954eec81fbf5fc1b64f733ec3e82be292483

data/.env.example

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

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.env*.local
+.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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wcc-data.gemspec
+gemspec
+
+gem 'rack', '~>1.6.5'

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/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/circle.yml

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

data/lib/wcc/data/faraday_client_app_token_auth.rb

@@ -1,64 +1,83 @@
+
+begin
+  gem 'faraday'
+  require 'faraday'
+rescue Gem::LoadError
+  # suppress
+end
+
+
 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
+  if defined?(Faraday)
+    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 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)
+          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 }
+        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
-    end
 
-    attr_reader :cache, :token_factory
+      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 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 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)
+      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
-    end
 
-    private
+      private
 
-    def default_token_factory(host)
-      WCC::Data::Nucleus::ClientAppToken.create(hostname: host).token
-    end
+      def default_token_factory(host)
+        WCC::Data::Nucleus::ClientAppToken.create(hostname: host).token
+      end
 
-    def default_cache
-      RedisCache.new(Sidekiq.method(:redis))
+      def default_cache
+        RedisCache.new(Sidekiq.method(:redis))
+      end
+    end
+  else
+    class FaradayClientAppTokenAuth
+      def initialize(app, cache: default_cache, token_factory: method(:default_token_factory))
+        raise NotSupportedError, 'Please include the "faraday" gem to use this authentication method'
+      end
     end
   end
 end
 
-Faraday::Middleware.register_middleware :client_app_token => lambda { WCC::Data::FaradayClientAppTokenAuth }
+if defined?(Faraday)
+  Faraday::Middleware.register_middleware :client_app_token => lambda { WCC::Data::FaradayClientAppTokenAuth }
+end
 

data/lib/wcc/data/nucleus/campus.rb

@@ -27,11 +27,11 @@ module WCC::Data::Nucleus
           code: 'FTW',
           name: 'Fort Worth',
           key: :ft_worth,
-          street: '8000 Western Hills Blvd',
+          street: '3345 Winthrop Avenue',
           city: 'Fort Worth',
           state: 'TX',
-          zip: '76108',
-          geo: [32.739972, -97.455414]
+          zip: '76116',
+          geo: [32.7280064, -97.4146727]
         },
         {
           id: 3,
@@ -54,28 +54,6 @@ module WCC::Data::Nucleus
           state: 'TX',
           zip: '75034',
           geo: [33.130761, -96.822322]
-        },
-        {
-          id: 5,
-          code: 'SDL',
-          name: 'South Dallas',
-          key: :south_dallas,
-          street: '3400 Garden Ln',
-          city: 'Dallas',
-          state: 'TX',
-          zip: '75215',
-          geo: [32.758418, -96.743966]
-        },
-        {
-          id: 6,
-          code: 'ROC',
-          name: 'Rockwall',
-          key: :rockwall,
-          street: '1565 Airport Rd',
-          city: 'Rockwall',
-          state: 'TX',
-          zip: '75087',
-          geo: [32.926936, -96.439255]
         }
       ]
     end

data/lib/wcc/data/version.rb

@@ -1,5 +1,5 @@
 module WCC
   module Data
-    VERSION = '0.3.9'.freeze
+    VERSION = '0.4.0.pre'.freeze
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+SPEC_DIR = File.dirname(__FILE__)
+FIXTURES_DIR = File.join(SPEC_DIR, "fixtures")
+
+$LOAD_PATH.unshift File.join(SPEC_DIR, "..", "lib")
+$LOAD_PATH.unshift SPEC_DIR
+
+require 'dotenv'
+Dotenv.load
+
+require 'wcc/data'
+require 'sidekiq'
+
+Dir[File.join(SPEC_DIR, "support", "*.rb")].each do |support_file|
+  require "support/#{File.basename(support_file, ".rb")}"
+end
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+
+  ENV['NUCLEUS_URL'] ||= 'http://login.wcc'
+end

data/spec/support/inheritable_class_attribute_examples.rb

@@ -0,0 +1,16 @@
+shared_examples_for :inheritable_class_attributes do |name|
+  let(:subclass) { Class.new(subject) }
+
+  it "inherited value is the same as parent class" do
+    subject.send(:instance_variable_set, :"@#{name}", foo: :bar)
+    expect(subject.send(name)).to eq(foo: :bar)
+    expect(subclass.send(name)).to eq(foo: :bar)
+  end
+
+  it "inherited reference is unique from the parent class" do
+    subject.send(:instance_variable_set, :"@#{name}", foo: :bar)
+    subclass.send(name)[:bar] = :baz
+    expect(subject.send(name)).to eq(foo: :bar)
+  end
+end
+

data/spec/wcc/data/config_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe WCC::Data::Config::Application do
+  let(:unit) { WCC::Data::Config::Application }
+  subject { unit.new(:name) }
+
+  describe "#initialize" do
+    it "takes a single name symbol and stores in @name" do
+      obj = unit.new(:name)
+      expect(obj.name).to eq(:name)
+    end
+
+    it "takes a connection option and stores it in @connection" do
+      obj = unit.new(:name, connection: "foo")
+      expect(obj.connection).to eq("foo")
+    end
+
+    it "sets to a blank Faraday::Connection" do
+      obj = unit.new(:name)
+      expect(obj.connection).to be_a(Faraday::Connection)
+    end
+  end
+
+  describe "#uri=" do
+    it "converts a string to a URI and stores in @uri" do
+      subject.uri = "http://test"
+      expect(subject.uri).to be_a(URI)
+      expect(subject.uri.scheme).to eq("http")
+    end
+
+    it "uses the URI object if set with a URI" do
+      subject.uri = test_value = URI("http://test")
+      expect(subject.uri).to eq(test_value)
+    end
+  end
+
+  describe "#service" do
+    before(:each) do
+      subject.uri = "http://test.com/"
+    end
+
+    it "returns a service object based on the URI" do
+      obj = subject.service
+      expect(obj).to be_a(WCC::Data::Service)
+      expect(obj.uri).to eq(subject.uri)
+    end
+
+    it "passes the application connection through to the service" do
+      obj = subject.service
+      expect(obj.connection).to eq(subject.connection)
+    end
+  end
+
+  describe "@connection" do
+    it "gets and sets" do
+      subject.connection = "foo"
+      expect(subject.connection).to eq("foo")
+    end
+  end
+end
+
+describe WCC::Data::Config do
+  let(:unit) { WCC::Data::Config }
+  subject { unit.new }
+
+
+  describe "#applications" do
+    it "returns a hash" do
+      expect(subject.applications).to be_a(Hash)
+    end
+
+    it "defaults empty keys to an application" do
+      expect(subject.applications[:foo]).to be_a(WCC::Data::Config::Application)
+    end
+
+    it "contains a default entry for :nucleus" do
+      expect(subject.applications[:nucleus].uri).to eq(
+        URI(ENV['NUCLEUS_URL'])
+      )
+    end
+
+    context "with APP_CLIENT_ID and APP_CLIENT_SECRET ENV vars set" do
+      after do
+        ENV['APP_CLIENT_ID'] = ENV['APP_CLIENT_SECRET'] = nil
+      end
+
+      it "sets the connection's basic auth for nucleus" do
+        ENV['APP_CLIENT_ID'] = "test"
+        ENV['APP_CLIENT_SECRET'] = "value"
+
+        header = subject.applications[:nucleus].connection.headers["Authorization"]
+
+        expect(header)
+          .to eq(Faraday::Request::BasicAuthentication.header("test", "value"))
+      end
+    end
+
+    context "with APP_CLIENT_ID and APP_CLIENT_SECRET not both set" do
+      it "does not set the basic auth for nucleus" do
+        header = subject.applications[:nucleus].connection.headers["Authorization"]
+
+        expect(header).to be_nil
+      end
+    end
+  end
+
+  describe "#apps alias" do
+    it "aliases to #applications" do
+      expect(subject.apps).to eq(subject.applications)
+    end
+  end
+
+end

data/spec/wcc/data/enumerated_type_spec.rb

@@ -0,0 +1,176 @@
+require "spec_helper"
+
+describe WCC::Data::EnumeratedType do
+
+  context "with configured attributes" do
+    let(:type) {
+      Class.new(described_class) do
+        attributes :test1, :test2
+      end
+    }
+    let(:object) { type.new(data) }
+    let(:data) {
+      {
+        test1: "test data 1",
+        test2: "test data 2",
+        ignored: "",
+      }
+    }
+
+    it "adds a method for all arguments passed" do
+      expect(object).to respond_to(:test1)
+      expect(object).to respond_to(:test2)
+    end
+
+    it "sets values from initialize hash" do
+      expect(object.test1).to eq("test data 1")
+      expect(object.test2).to eq("test data 2")
+    end
+
+    describe "::defined_attributes" do
+      it "should return attributes" do
+        expect(type.defined_attributes).to eq([:test1, :test2])
+      end
+    end
+  end
+
+  context "with child classes" do
+    let(:parent) {
+      Class.new(described_class) do
+        attributes :attr1
+        attributes :attr2
+      end
+    }
+    let(:child) {
+      Class.new(parent) do
+        attributes :attr3, :attr4
+      end
+    }
+    let(:parent_object) { parent.new(data) }
+    let(:child_object) { child.new(data) }
+    let(:data) {
+      {
+        attr1: "data1",
+        attr2: "data2",
+        attr3: "data3",
+        attr4: "data4",
+      }
+    }
+
+    describe "parent class" do
+      it "does not include child attributes" do
+        expect(parent_object).to_not respond_to(:attr3)
+        expect(parent_object).to_not respond_to(:attr4)
+      end
+
+      it "includes both attributes" do
+        expect(parent_object).to respond_to(:attr1)
+        expect(parent_object).to respond_to(:attr2)
+      end
+
+      it "sets both attributes on initialize" do
+        expect(parent_object.attr1).to eq("data1")
+        expect(parent_object.attr2).to eq("data2")
+      end
+    end
+
+    describe "child class" do
+      it "includes all defined_attributes" do
+        expect(child.defined_attributes).to eq([:attr1, :attr2, :attr3, :attr4])
+      end
+
+      it "includes parent attributes and child attributes readers" do
+        expect(child_object.attr1).to eq("data1")
+        expect(child_object.attr2).to eq("data2")
+        expect(child_object.attr3).to eq("data3")
+        expect(child_object.attr4).to eq("data4")
+      end
+    end
+
+  end
+
+  context "with db, matches?, and attributes configured" do
+    let(:type) {
+      Class.new(described_class) do
+        attributes :id, :name, :key
+
+        def matches?(value)
+          [id, key].include?(value)
+        end
+
+        def self.db
+          [
+            { id: 1, name: "One", key: :one },
+            { id: 2, name: "Two", key: :two },
+            { id: 3, name: "Three", key: :three },
+            { id: 4, name: "Four", key: :three },
+          ]
+        end
+      end
+    }
+
+    describe "::[]" do
+      it "returns an instance of type if match found" do
+        expect(type[1]).to be_a(type)
+      end
+
+      it "returns nil if no match found" do
+        expect(type[:nil]).to be_nil
+      end
+
+      it "returns first match when multiple matches present" do
+        expect(type[:three]).to eq(type.all[2])
+      end
+    end
+
+    describe "::all" do
+      it "returns instances of EnumeratedType for each item in db" do
+        expect(type.all.size).to eq(4)
+        expect(type.all[0]).to be_a(type)
+        expect(type.all[1]).to be_a(type)
+        expect(type.all[2]).to be_a(type)
+        expect(type.all[3]).to be_a(type)
+      end
+
+      it "sets attributes for each record properly" do
+        expect(type.all[0].id).to eq(1)
+        expect(type.all[0].name).to eq("One")
+        expect(type.all[0].key).to eq(:one)
+        expect(type.all[1].key).to eq(:two)
+        expect(type.all[2].key).to eq(:three)
+      end
+
+      it "caches the results" do
+        expect(type.all[0].object_id).to eq(type.all[0].object_id)
+      end
+    end
+
+    describe "::reset" do
+      it "clears out all and forces new object creation" do
+        first_id = type.all[0].object_id
+        type.reset
+        expect(type.all[0].object_id).to_not eq(first_id)
+      end
+    end
+  end
+
+  describe "#initialize" do
+    it "allows passing no argument" do
+      expect { described_class.new }.to_not raise_error
+    end
+  end
+
+  describe "::db" do
+    it "raises NotImplementedError with instructions" do
+      expect { described_class.db }.to raise_error(NotImplementedError, /subclass/i)
+    end
+  end
+
+  describe "#matches?" do
+    it "raises NotImplementedError with instructions" do
+      object = described_class.new({})
+      expect { object.matches?(:val) }.to raise_error(NotImplementedError, /subclass/i)
+    end
+  end
+
+end