mirror_mirror 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,11 @@
+New BSD License
+Copyright (c) 1999 - 2012, Daniel Doezema
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* The names of the contributors and/or copyright holder may not be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DANIEL DOEZEMA BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,70 @@
+# MirrorMirror
+
+A Ruby gem that allows for easier interactions and integration with external REST resources.
+
+## Installation
+
+    gem 'mirror_mirror'
+
+## Usage Example
+
+### Environment 
+    
+    # App controlled resource, reliant on external resource.
+    class Timesheet < ActiveRecord::Base
+      belongs_to :contractor, :auto_reflect => true
+    end
+
+    # Extenal Resource
+    class Contractor < ActiveRecord::Base
+      has_many :timesheets
+      
+      mirror_mirror "http://api.example.com/v1/contractors", 
+                    :request => :resource_request, :find => true
+        
+      def resource_request(verb, url, params)
+        response = RestClient.send(verb, url + '.json', params)
+        ActiveSupport::JSON.decode(response.to_str)["result"] if response.code == 200
+      end
+    end
+    
+    # API Resource Example
+    {
+      result: [{
+        id: 1,
+        first_name: "Daniel",
+        last_name: "Doezema"
+      },
+      {
+        id: 2,
+        first_name: "John",
+        last_name: "Doe"
+      }]
+    } 
+ 
+### External API Scenario
+  
+    class ContractorsController < ApiController
+      # api/contractors/:id/clock_out
+      def clock_out
+        # Automatically found & created b/c of the mirror_mirror :find => true option
+        contractor  = Contractor.find(params[:id])
+        timesheet   = contractor.timesheets.last
+        result      = timesheet.update_attributes(:ended_at => Time.now)
+      end
+    end
+    
+### The "We've only got an id" Scenario
+
+In this scenario a `contractor_id` is present, but we don't know if the `Contractor` record exists locally yet -- this is where the `:auto_reflect` option helps out. If a local `Contractor` record is not found then a request will automatically be made to fetch and create it.
+
+    # Controller
+    @timesheets = Timesheet.where("started_at > ?", Time.now.beginning_of_day)
+    
+    # View
+    <h1>Today's Punched-In Contractors</h1>
+    <ul>
+      <% @timesheets.each do |timesheet| %>
+        <li><%= "#{timesheet.worker.first_name} #{timesheet.worker.last_name}"</li>
+      <% end %>
+    </ul>

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/mirror_mirror/active_record_base.rb

@@ -0,0 +1,136 @@
+module MirrorMirror::ActiveRecordBase
+  extend ActiveSupport::Concern
+
+  included do
+    
+    def reflect!
+      hash = self.class.mirror_request!(:get, mirror_url)
+      raise RecordNotFound, "Non-Hash returned from resource: #{mirror_url} => #{hash.inspect}" unless hash.is_a?(Hash)
+      raise RecordNotFound, "Empty hash returned from resource."  unless hash.any?
+      hash.each {|k,v| send("#{k}=", v) if respond_to?("#{k}=") }
+      self.updated_at = Time.now
+      save!
+      self
+    end
+
+    def mirror_url
+      self.class.mirror_url(id)
+    end
+
+  end
+
+  module ClassMethods
+    
+    def mirror_mirror(*args)
+      options = args.extract_options!
+      raise ArgumentError, "url is blank." if args[0].blank?
+      options[:url]           = args[0]
+      @mirror_mirrior_options = options
+    end
+
+    def mirroring?
+      @mirror_mirrior_options.present?
+    end
+
+    def mirror_mirror_options(option)
+      @mirror_mirrior_options ||= {}
+      @mirror_mirrior_options[option]
+    end
+
+    def mirror_find?
+      mirroring? ? @mirror_mirrior_options[:find] : false
+    end
+
+    def mirror_url(id = nil)
+      url = @mirror_mirrior_options[:url]
+      url += "/#{id.to_i}" if id.to_i > 0
+      url
+    end
+
+    def mirror_request!(verb, url, params = {})
+      method = @mirror_mirrior_options[:request]
+      if method.present?
+        raise ArgumentError, "url is blank."          if url.blank?
+        raise ArgumentError, "verb is invalid."       unless verb.in?([:get, :put, :post, :delete])
+        raise ArgumentError, "params is not a Hash."  unless params.is_a?(Hash) 
+        begin
+          send(method, verb, url, params)
+        rescue => e
+          raise FailedRequest, "#{verb.to_s.upcase} #{url} :: Params: #{params} :: Initial Exception: #{e.class.name}: #{e}"
+        end
+      elsif MirrorMirror.request?
+        MirrorMirror.request(verb, url, params)
+      else
+         raise FailedRequest, "No request method specified."
+      end
+    end
+
+    def reflect_all!(params = {})
+      array = mirror_request(:get, mirror_url, params)
+      raise RecordNotFound, "Non-Array returned from resource: #{mirror_url} => #{hash.inspect}" unless array.is_a?(Array)
+      if array.any?
+        transaction do
+          array.each do |hash|
+            if (id = hash["id"]).present?
+              record = find_or_initialize_by_id(id)
+              hash.each {|k,v| record.send("#{k}=", v) if record.respond_to?("#{k}=") }
+            end
+            record.updated_at = Time.now
+            record.save!
+          end
+        end
+      end
+      all
+    end
+
+    # Active Record Polymorphing
+    def find(*args)
+      return super unless mirror_find?
+      begin
+        super
+      rescue ActiveRecord::RecordNotFound
+        if (id = args[0].to_i) > 0
+          record    = self.new
+          record.id = id
+          record.reflect!
+        end
+      end
+    end
+
+    def reflect_by_id!(id)
+      record = self.new
+      record.id = id
+      record.reflect!
+      record
+    end
+
+    def find_or_reflect_by_id!(*args)
+      record = find_or_initialize_by_id(*args)
+      record.reflect! if record.new_record?
+      record
+    end
+
+    def belongs_to(*args)
+      options           = args.extract_options!
+      association_name  = args[0].to_s
+      options.delete(:auto_reflect) if auto_reflect = options[:auto_reflect].presence
+      if auto_reflect
+        self.class_eval <<-RUBY
+          def #{association_name}
+            if (result = super).blank?
+              model = send("#{association_name}_type").constantize
+              id    = send("#{association_name}_id")
+              if id.present? && model.mirroring? 
+                model.reflect_by_id!(id)
+                result = super(true)
+              end
+            end
+            result
+          end
+        RUBY
+      end
+      super(*(args << options))
+    end
+
+  end 
+end

data/lib/mirror_mirror/railtie.rb

@@ -0,0 +1,11 @@
+module MirrorMirror
+  class Railtie < Rails::Railtie
+
+    initializer 'mirror_mirror.active_record_base' do |app|
+      ActiveSupport.on_load :active_record do
+        include MirrorMirror::ActiveRecordBase
+      end
+    end
+
+  end
+end

data/lib/mirror_mirror/version.rb

@@ -0,0 +1,3 @@
+module MirrorMirror
+  VERSION = "0.0.1"
+end

data/lib/mirror_mirror.rb

@@ -0,0 +1,30 @@
+require "mirror_mirror/version"
+
+module MirrorMirror
+  autoload :ActiveRecordBase, 'mirror_mirror/active_record_base' 
+
+  class RecordNotFound < ::StandardError; end
+  class FailedRequest < ::StandardError; end
+
+  class << self
+    def request!(verb = :get, url = nil, params = {}, &block)
+      unless block_given?
+        raise ArgumentError, "url is blank."          if url.blank?
+        raise ArgumentError, "verb is invalid."       unless verb.in?([:get, :put, :post, :delete])
+        raise ArgumentError, "params is not a Hash."  unless params.is_a?(Hash)
+        begin
+          return @request_proc.call(verb, url, params)
+        rescue => e
+          raise FailedRequest, "#{verb.to_s.upcase} #{url} :: Params: #{params} :: Initial Exception: #{e.class.name}: #{e}"
+        end
+      end
+      @request_proc = Proc.new(&block)
+    end
+
+    def request?
+      @request_proc.present?
+    end
+  end
+end
+
+require 'mirror_mirror/railtie' if defined?(Rails)

data/mirror_mirror.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mirror_mirror/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Daniel Doezema"]
+  gem.email         = ["daniel.doezema@gmail.com"]
+  gem.description   = %q{Allows for easier interactions and integration with external REST resources.}
+  gem.summary       = %q{Allows for easier interactions and integration with external REST resources.}
+  gem.homepage      = "https://github.com/veloper/mirror_mirror"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mirror_mirror"
+  gem.require_paths = ["lib"]
+  gem.version       = MirrorMirror::VERSION
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: mirror_mirror
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Daniel Doezema
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-17 00:00:00 Z
+dependencies: []
+
+description: Allows for easier interactions and integration with external REST resources.
+email: 
+- daniel.doezema@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mirror_mirror.rb
+- lib/mirror_mirror/active_record_base.rb
+- lib/mirror_mirror/railtie.rb
+- lib/mirror_mirror/version.rb
+- mirror_mirror.gemspec
+homepage: https://github.com/veloper/mirror_mirror
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Allows for easier interactions and integration with external REST resources.
+test_files: []
+