lazy_resource 0.1.0

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--debugger
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@lazy_resource --create

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lazy_resource.gemspec
+gemspec
+
+# Development gems
+gem 'pry'
+gem 'debugger'
+gem 'rake'
+
+gem 'rspec'
+gem 'simplecov', :require => false
+gem 'guard-rspec'
+gem 'growl'

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2, :cli => "--color --format documentation" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/lazy_resource/(.+)\.rb$})     { |m| "spec/lazy_resource/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrew Latimer
+
+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,127 @@
+# LazyResource
+
+[ActiveResource](http://github.com/rails/activeresource) with its feet
+up. The block less, do more consumer of delicious APIs.
+
+LazyResource is `ActiveRecord` made less blocking. Built on top of
+[Typhoeus](https://github.com/typhoeus/typhoeus), it queues up your requests to make your
+API consumer a whole lot quicker. Work smarter, not harder.
+
+It also has a simple, readable, easy-to-use API, borrowing some of the
+best parts of ActiveResource with a bit of ActiveRecord method-chaining
+flair. Not only is it faster, it's better-looking, too.
+
+Don't believe me? Check out some of the examples in the `examples` directory
+to see for yourself.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lazy_resource'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lazy_resource
+
+## Usage
+
+### Define a model:
+
+    class User
+      include LazyResource::Resource
+
+      self.site = 'http://example.com'
+
+      attribute :id, Integer
+      attribute :first_name, String
+      attribute :last_name, String
+    end
+
+### Then use it:
+
+    me = User.find(1)                                                    # => GET /users/1
+    bobs = User.where(:first_name => 'Bob')                              # => GET /users?first_name=Bob
+    sam = User.find_by_first_name('Sam')                                 # => GET /users?first_name=Sam
+    terry = User.new(:first_name => 'Terry', :last_name => 'Simpson')
+    terry.save                                                           # => POST /users
+    terry.last_name = 'Jackson'
+    terry.save                                                           # => PUT /users/4
+    terry.destroy                                                        # => DELETE /users/4
+
+### What about associations?
+
+    class Post
+      include LazyResource::Resource
+
+      self.site = 'http://example.com'
+
+      attribute :id, Integer
+      attribute :title, String
+      attribute :body, String
+      attribute :user, User
+    end
+
+    class User
+      include LazyResource::Resource
+      # Attributes that have a type in an array are has-many
+      attribute :posts, [Post]
+    end
+
+    me = User.find(1)
+    me.posts.all       # => GET /users/1/posts
+
+### That's cool, but what if my end-point doesn't map with my association name?
+
+    class Photo
+      include LazyResource::Resource
+
+      attribute :id, Integer
+      attribute :urls, Hash
+      attribute :photographer, User, :from => 'users'
+    end
+
+### I thought you said this was non-blocking?
+
+It is. That original example above with me, the Bobs, Sam, and Terry? Those
+first four requests would all get executed at the same time, when Terry
+was saved. Pretty neat, eh?
+
+### That's great, but could you show me some examples that are a bit more complex?
+
+Sure thing! Take a look at the files in the `examples` directory, or
+read through the specs.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Make sure you have some decent test coverage, and please don't bump up
+the version number. If you want to maintain your own version, go for it,
+but put it in a separate commit so I can ignore it when I merge the rest
+of your stuff in.
+
+## Recognition
+
+Thanks to:
+
+* [Typhoeus](http://github.com/typhoeus/typhoeus) for the http request
+  queuing code that forms the foundation of LazyResource.
+* [ActiveResource](http://github.com/rails/activeresource) for the idea
+  (and a bit of code).
+* [Get Satisfaction](http://getsatisfaction.com) for putting food on my
+  table.
+
+## TODO
+
+ * Clean up `LazyResource::Attributes#create_setter`
+ * Add more specs for associations
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/examples/github.rb

@@ -0,0 +1,64 @@
+require 'lazy_resource'
+require 'benchmark'
+
+LazyResource.configure do |config|
+  config.site = "https://api.github.com"
+end
+
+class User
+  include LazyResource::Resource
+end
+
+class Repo
+  include LazyResource::Resource
+
+  attribute :id,          Fixnum
+  attribute :pushed_at,   DateTime
+  attribute :owner,       User
+  attribute :clone_url,   String
+  attribute :name,        String
+  attribute :description, String
+end
+
+class User
+  include LazyResource::Resource
+
+  self.primary_key_name = 'login'
+
+  attribute :id,          Fixnum
+  attribute :login,       String
+  attribute :name,        String
+  attribute :bio,         String
+  attribute :company,     String
+  attribute :number_of_public_repos, Fixnum, :from => 'public_repos'
+  attribute :repos,       [Repo]
+end
+
+dhh = User.find('dhh')
+dhh.repos.each do |repo|
+  puts "#{dhh.name} pushed to #{repo.name} on #{repo.pushed_at.strftime("%D")}"
+end
+
+puts "Fetching 10 users serially..."
+Benchmark.bm do |x|
+  x.report do
+    names = []
+    10.times do |i|
+      u = User.find(i + 1)
+      names << u.name
+    end
+    
+    puts names
+  end
+end
+
+puts "\nFetching 10 users in parallel..."
+Benchmark.bm do |x|
+  x.report do
+    users = []
+    10.times do |i|
+      users << User.find(i + 1)
+    end
+    puts users.map { |user| user.name }
+  end
+end

data/lazy_resource.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/lazy_resource/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrew Latimer"]
+  gem.email         = ["andrew@elpasoera.com"]
+  gem.description   = %q{ActiveResource with it's feet up. The write less, do more consumer of delicious APIs.}
+  gem.summary       = %q{ActiveResource with it's feet up. The write less, do more consumer of delicious APIs.}
+  gem.homepage      = "http://github.com/ahlatimer/lazy_resource"
+
+  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          = "lazy_resource"
+  gem.require_paths = ["lib"]
+  gem.version       = LazyResource::VERSION
+
+  gem.add_dependency 'activemodel', '>= 3.1.0'
+  gem.add_dependency 'activesupport', '>= 3.1.0'
+  gem.add_dependency 'json', '>= 1.5.2'
+  gem.add_dependency 'typhoeus', '>= 0.2.4'
+end

data/lib/lazy_resource.rb

@@ -0,0 +1,39 @@
+require 'active_model'
+require 'active_support'
+require 'json'
+require 'typhoeus'
+
+require 'active_support'
+require 'active_support/core_ext/class/attribute_accessors'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/kernel/reporting'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/object/to_query'
+require 'active_support/core_ext/object/duplicable'
+require 'set'
+require 'uri'
+
+require 'active_support/core_ext/uri'
+
+require 'lazy_resource/version'
+require 'lazy_resource/errors'
+
+module LazyResource
+  extend ActiveSupport::Autoload
+  
+  autoload :Attributes
+  autoload :Mapping
+  autoload :Relation
+  autoload :Request
+  autoload :Resource
+  autoload :ResourceQueue
+  autoload :Types
+  autoload :UrlGeneration
+
+  def self.configure(&block)
+    yield Resource
+  end
+end

data/lib/lazy_resource/attributes.rb

@@ -0,0 +1,131 @@
+module LazyResource
+  module Attributes
+    extend ActiveSupport::Concern
+    include ActiveModel::Dirty
+
+    module ClassMethods
+      def attribute(name, type, options={})
+        attributes[name] = { :type => type, :options => options }
+
+        create_getter(name, type, options) unless options[:skip_getter]
+        create_setter(name, type, options) unless options[:skip_setter]
+        create_question(name, type, options) unless options[:skip_question] || options[:skip_getter]
+
+        @attribute_methods_generated = false
+        define_attribute_methods [name]
+      end
+
+      def fetch_all
+        self.resource_queue.send_to_request_queue! if self.respond_to?(:resource_queue)
+        self.request_queue.run if self.respond_to?(:request_queue)
+      end
+
+      def attributes
+        @attributes ||= {}
+      end
+
+      def primary_key_name
+        @primary_key_name ||= 'id'
+      end
+
+      def primary_key_name=(pk)
+        @primary_key_name = pk
+      end
+
+      attr_writer :element_name
+      def element_name
+        @element_name ||= model_name.element
+      end
+
+      attr_writer :collection_name
+      def collection_name
+        @collection_name ||= ActiveSupport::Inflector.pluralize(element_name)
+      end
+
+      protected
+      def create_setter(name, type, options={})
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}=(value)
+            self.class.fetch_all if !fetched?
+
+            #{name}_will_change! unless @#{name} == value || (!fetched? && persisted?)
+            @#{name} = value
+          end
+        RUBY
+      end
+
+      def create_getter(name, type, options={})
+        method = <<-RUBY
+          def #{name}
+            self.class.fetch_all if !fetched
+        RUBY
+
+        if type.is_a?(Array) && type.first.include?(LazyResource::Resource)
+          if options[:using].nil?
+            method << <<-RUBY
+              if @#{name}.nil?
+                @#{name} = #{type.first}.where(:"\#{self.class.element_name}_id" => self.primary_key)
+              end
+            RUBY
+          else
+            method << <<-RUBY
+              return [] if self.#{options[:using]}.nil?
+
+              if @#{name}.nil?
+                @#{name} = LazyResource::Relation.new(#{type.first}, :fetched => true)
+                @#{name}.fetched = false
+                request = LazyResource::Request.new(self.#{options[:using]}, @#{name})
+                self.class.request_queue.queue(request)
+              end
+
+              @#{name}
+            RUBY
+          end
+        elsif type.include?(LazyResource::Resource)
+          if options[:using].nil?
+            method << <<-RUBY
+              if @#{name}.nil?
+                @#{name} = #{type}.where(:"\#{self.class.element_name}_id" => self.primary_key)
+              end
+            RUBY
+          else
+            method << <<-RUBY
+              return [] if self.#{options[:using]}.nil?
+
+              if @#{name}.nil?
+                @#{name} = #{type}.new
+                request = LazyResource::Request.new(self.#{options[:using]}, @#{name})
+                self.class.request_queue.queue(request)
+              end
+
+              @#{name}
+            RUBY
+          end
+        end
+
+        method << <<-RUBY
+            @#{name}
+          end
+        RUBY
+
+        class_eval method, __FILE__, __LINE__ + 1
+      end
+
+      def create_question(name, type, options={})
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}?
+            !!self.#{name}
+          end
+        RUBY
+      end
+    end
+
+    def primary_key
+      self.send(self.class.primary_key_name)
+    end
+
+    included do
+      extend ActiveModel::Naming
+    end
+  end
+end