aptible-resource 0.1.0

data/lib/hyper_resource/modules/internal_attributes.rb

@@ -0,0 +1,90 @@
+module HyperResource::Modules
+  module InternalAttributes
+
+    def self.included(base)
+      base.extend(ClassMethods)
+
+      base._hr_class_attributes.each do |attr|
+        base._hr_class_attribute attr
+      end
+
+      (base._hr_attributes - base._hr_class_attributes).each do |attr|
+         base.send(:attr_accessor, attr)
+      end
+
+      ## Fallback attributes fall back from instance to class.
+      (base._hr_attributes & base._hr_class_attributes).each do |attr|
+         base._hr_fallback_attribute attr
+      end
+    end
+
+    module ClassMethods
+
+      def _hr_class_attributes # @private
+        [ :root,             ## e.g. 'https://example.com/api/v1'
+          :auth,             ## e.g. {:basic => ['username', 'password']}
+          :headers,          ## e.g. {'Accept' => 'application/vnd.example+json'}
+          :namespace,        ## e.g. 'ExampleAPI', or the class ExampleAPI itself
+          :adapter,          ## subclass of HR::Adapter
+          :faraday_options   ## e.g. {:request => {:timeout => 30}}
+        ]
+      end
+
+      def _hr_attributes # @private
+        [ :root,
+          :href,
+          :auth,
+          :headers,
+          :namespace,
+          :adapter,
+          :faraday_options,
+
+          :request,
+          :response,
+          :body,
+
+          :attributes,
+          :links,
+          :objects,
+
+          :loaded
+        ]
+      end
+
+      ## Inheritable class attribute, kinda like in Rails.
+      def _hr_class_attribute(*names)
+        names.map(&:to_sym).each do |name|
+          instance_eval <<-EOT
+            def #{name}=(val)
+              @#{name} = val
+            end
+            def #{name}
+              return @#{name} if defined?(@#{name})
+              return superclass.#{name} if superclass.respond_to?(:#{name})
+              nil
+            end
+          EOT
+        end
+      end
+
+      ## Instance attributes which fall back to class attributes.
+      def _hr_fallback_attribute(*names)
+        names.map(&:to_sym).each do |name|
+          class_eval <<-EOT
+            def #{name}=(val)
+              @#{name} = val
+            end
+            def #{name}
+              return @#{name} if defined?(@#{name})
+              return self.class.#{name} if self.class.respond_to?(:#{name})
+              nil
+            end
+          EOT
+        end
+      end
+
+    end # ClassMethods
+
+  end
+end
+

data/lib/hyper_resource/objects.rb

@@ -0,0 +1,60 @@
+class HyperResource
+  class Objects < Hash
+    attr_accessor :_resource
+
+    def initialize(resource=nil) 
+      self._resource = resource || HyperResource.new
+    end
+
+    ## Creates accessor methods in self.class and self._resource.class.
+    ## Protects against method creation into HyperResource::Objects and
+    ## HyperResource classes.  Just subclasses, please!
+    def _hr_create_methods!(opts={}) # @private
+      return if self.class.to_s == 'HyperResource::Objects'
+      return if self._resource.class.to_s == 'HyperResource' 
+      return if self.class.send(
+        :class_variable_defined?, :@@_hr_created_objects_methods) 
+
+      self.keys.each do |attr|
+        attr_sym = attr.to_sym
+
+        self.class.send(:define_method, attr_sym) do
+          self[attr]
+        end
+
+        ## Don't stomp on _resource's methods
+        unless _resource.respond_to?(attr_sym)
+          _resource.class.send(:define_method, attr_sym) do
+            objects.send(attr_sym)
+          end
+        end
+      end
+
+      self.class.send(:class_variable_set, :@@_hr_created_objects_methods, true) 
+    end
+
+    def []=(attr, value) # @private
+      super(attr.to_s, value)
+    end
+
+    ## When +key+ is a string, returns the array of objects under that name.
+    ## When +key+ is a number, returns +ith(key)+. Returns nil on lookup
+    ## failure.
+    def [](key)
+      case key
+      when String, Symbol
+        return super(key.to_s) if self.has_key?(key.to_s)
+        return super(key.to_sym) if self.has_key?(key.to_sym)
+      when Fixnum
+        return ith(key)
+      end
+      nil
+    end
+
+    def method_missing(method, *args) # @private
+      return self[method] if self[method]
+      raise NoMethodError, "undefined method `#{method}' for #{self.inspect}"
+    end
+
+  end
+end

data/lib/hyper_resource/response.rb

@@ -0,0 +1,2 @@
+class HyperResource::Response < Hash
+end

data/lib/hyper_resource/version.rb

@@ -0,0 +1,4 @@
+class HyperResource
+  VERSION = '0.2.4'
+  VERSION_DATE = '2014-04-02'
+end

data/spec/aptible/resource/base_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Aptible::Resource::Base do
+  subject { Api.new }
+
+  describe '#initialize' do
+    it 'should be a HyperResource instance' do
+      expect(subject).to be_a HyperResource
+    end
+
+    it 'should require root_url to be defined' do
+      expect { described_class.new }.to raise_error
+    end
+  end
+
+  describe '#bearer_token' do
+    it 'should accept an Aptible::Resource::Token' do
+      token = Api::Token.new
+      token.stub(:access_token) { 'aptible_auth_token' }
+      subject.stub(:token) { token }
+      expect(subject.bearer_token).to eq token.access_token
+    end
+
+    it 'should accept a Fridge::AccessToken' do
+      token = Fridge::AccessToken.new
+      token.stub(:to_s) { 'fridge_access_token' }
+      subject.stub(:token) { token }
+      expect(subject.bearer_token).to eq token.to_s
+    end
+
+    it 'should accept a String' do
+      subject.stub(:token) { 'token' }
+      expect(subject.bearer_token).to eq 'token'
+    end
+  end
+end

data/spec/aptible/resource/model_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Aptible::Resource::Model do
+  subject { Api.new }
+
+  describe '.collection_href' do
+    it 'should use the pluralized resource name' do
+      url = Api::Mainframe.collection_href
+      expect(url).to eq '/mainframes'
+    end
+  end
+
+  describe '.find' do
+    it 'should call find_by_url' do
+      url = '/mainframes/42'
+      expect(Api::Mainframe).to receive(:find_by_url).with url, {}
+      Api::Mainframe.find(42)
+    end
+  end
+
+  describe '.all' do
+    let(:mainframe) { double 'Mainframe' }
+    let(:collection) { double 'Api' }
+
+    before do
+      collection.stub(:mainframes) { [mainframe] }
+      Api::Mainframe.any_instance.stub(:find_by_url) { collection }
+    end
+
+    it 'should be an array' do
+      expect(Api::Mainframe.all).to be_a Array
+    end
+
+    it 'should return the root collection' do
+      expect(Api::Mainframe.all).to eq [mainframe]
+    end
+
+    it 'should pass options to the HyperResource initializer' do
+      klass = Api::Mainframe
+      options = { token: 'token' }
+      expect(klass).to receive(:new).with(options).and_return klass.new
+      Api::Mainframe.all(options)
+    end
+  end
+
+  describe '.create' do
+    it 'should create a new top-level resource' do
+      mainframes = double 'Api'
+      Api.stub_chain(:new, :mainframes) { mainframes }
+      expect(mainframes).to receive(:create).with(foo: 'bar')
+      Api::Mainframe.create(foo: 'bar')
+    end
+  end
+end

data/spec/fixtures/api.rb

@@ -0,0 +1,11 @@
+require 'aptible/resource'
+
+class Api < Aptible::Resource::Base
+  def namespace
+    'Api'
+  end
+
+  def root_url
+    'https://resource.example.com'
+  end
+end

data/spec/fixtures/mainframe.rb

@@ -0,0 +1,5 @@
+require_relative 'api'
+
+# rubocop:disable ClassAndModuleChildren
+class Api::Mainframe < Api
+end

data/spec/fixtures/token.rb

@@ -0,0 +1,5 @@
+require_relative 'api'
+
+# rubocop:disable ClassAndModuleChildren
+class Api::Token < Api
+end

data/spec/shared/set_env.rb

@@ -0,0 +1,10 @@
+def set_env(*args, &block)
+  hash = args.first.is_a?(Hash) ? args.first : Hash[*args]
+  old_values = Hash[hash.map { |k, v| [k, ENV[k]] }]
+  begin
+    hash.each { |k, v| ENV[k] = v }
+    yield
+  ensure
+    old_values.each { |k, v| ENV[k] = v }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+# Load shared spec files
+Dir["#{File.dirname(__FILE__)}/shared/**/*.rb"].each do |file|
+  require file
+end
+# Load spec fixtures
+Dir["#{File.dirname(__FILE__)}/fixtures/**/*.rb"].each do |file|
+  require file
+end
+
+# Require library up front
+require 'aptible/resource'

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: aptible-resource
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frank Macreery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uri_template
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+- !ruby/object:Gem::Dependency
+  name: json
+  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: fridge
+  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: activesupport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: aptible-tasks
+  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: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: Foundation classes for Aptible resource server gems
+email:
+- frank@macreery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- aptible-resource.gemspec
+- lib/aptible/resource.rb
+- lib/aptible/resource/adapter.rb
+- lib/aptible/resource/base.rb
+- lib/aptible/resource/model.rb
+- lib/aptible/resource/token.rb
+- lib/aptible/resource/version.rb
+- lib/hyper_resource.rb
+- lib/hyper_resource/adapter.rb
+- lib/hyper_resource/adapter/hal_json.rb
+- lib/hyper_resource/attributes.rb
+- lib/hyper_resource/exceptions.rb
+- lib/hyper_resource/link.rb
+- lib/hyper_resource/links.rb
+- lib/hyper_resource/modules/http.rb
+- lib/hyper_resource/modules/internal_attributes.rb
+- lib/hyper_resource/objects.rb
+- lib/hyper_resource/response.rb
+- lib/hyper_resource/version.rb
+- spec/aptible/resource/base_spec.rb
+- spec/aptible/resource/model_spec.rb
+- spec/fixtures/api.rb
+- spec/fixtures/mainframe.rb
+- spec/fixtures/token.rb
+- spec/shared/set_env.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aptible/aptible-resource
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Foundation classes for Aptible resource server gems
+test_files:
+- spec/aptible/resource/base_spec.rb
+- spec/aptible/resource/model_spec.rb
+- spec/fixtures/api.rb
+- spec/fixtures/mainframe.rb
+- spec/fixtures/token.rb
+- spec/shared/set_env.rb
+- spec/spec_helper.rb