restly 0.0.1.alpha.1 → 0.0.1.alpha.2

data/.rspec

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

data/README.md

@@ -1,6 +1,6 @@
 # Restly
 
-TODO: Write a gem description
+Restly is an ActiveModel based ODM (Object Document Mapper) for restful web-services. It includes the ability to define relationships to any Ruby class using some built in helpers.
 
 ## Installation
 
@@ -16,9 +16,69 @@ Or install it yourself as:
 
     $ gem install restly
 
-## Usage
+## Configuration
+In order for restly to funciton it will need some configuration. This can be done by placing restly.yml in your config directory. We have added a generator to make this easier.
 
-TODO: Write usage instructions here
+```sh
+$ rails generate restly:configuration
+```
+
+This will generate a file like so:
+
+```yaml
+development: &development
+  site: http://example.com # Change This
+  default_format: json # defaults to: json
+
+  ## Would you like requests to be cached?
+  # cache: true
+  # cache_options:
+  #   expires_in: 3600
+
+  ## Enable Oauth?
+  # use_oauth: true
+  # oauth_options:
+  #   client_id: %client_id%
+  #   client_secret: %client_secret%
+
+test:
+  <<: *development
+
+production:
+  site: http://example.com # Change This
+  default_format: json # defaults to: json
+
+  # Would you like requests to be cached?
+  cache: true
+  cache_options:
+     expires_in: 3600
+
+  ## Enable Oauth?
+  # use_oauth: true
+  # oauth_options:
+  #   client_id: %client_id%
+  #   client_secret: %client_secret%
+
+```
+
+## Creating a Restly Model
+
+# Using the generator
+
+```
+$ rails generate restly:model MyModel
+```
+
+This will generate a model that looks like this:
+
+```ruby
+class MyModel < Restly::Base
+
+  # self.resource_name = 'my_model'
+  # self.path = 'some_path/to_resource' # defaults to: 'resource_name.pluralized'
+
+end
+```
 
 ## Contributing
 

data/lib/generators/restly_config_generator.rb

@@ -0,0 +1,13 @@
+module Restly
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_config_file
+        template "config.yml.erb", "config/restly.yml"
+      end
+
+    end
+  end
+end

data/lib/generators/restly_model_generator.rb

@@ -0,0 +1,18 @@
+module Restly
+  module Generators
+    class ModelGenerator < Rails::Generators::NamedBase
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def initialize(args, *options) #:nodoc:
+        args[0] = args[0].gsub(/\./,'_')
+        super
+      end
+
+      def create_model_file
+        template "model.rb.erb", "app/models/#{file_name}.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/templates/config.yml.erb

@@ -0,0 +1,32 @@
+development: &development
+  site: http://example.com # Change This
+  default_format: json # defaults to: json
+
+  ## Would you like requests to be cached?
+  # cache: true
+  # cache_options:
+  #   expires_in: 3600
+
+  ## Enable Oauth?
+  # use_oauth: true
+  # oauth_options:
+  #   client_id: %client_id%
+  #   client_secret: %client_secret%
+
+test:
+  <<: *development
+
+production:
+  site: http://example.com # Change This
+  default_format: json # defaults to: json
+
+  # Would you like requests to be cached?
+  cache: true
+  cache_options:
+     expires_in: 3600
+
+  ## Enable Oauth?
+  # use_oauth: true
+  # oauth_options:
+  #   client_id: %client_id%
+  #   client_secret: %client_secret%

data/lib/generators/templates/model.rb.erb

@@ -0,0 +1,9 @@
+class <%= class_name %> < Restly::Base
+
+  ## Override the Site
+  # self.site = "anotherexample.com" # defaults to config's site
+  # self.resource_name = "some_other_name" # defaults to class_name.underscore
+  # self.path = "/some_other_path" # defaults to: resource_name.pluralized
+  # self.format = :json # defaults to :json
+
+end

data/lib/restly/associations/base.rb

@@ -12,24 +12,95 @@ class Restly::Associations::Base
     @options = options
   end
 
-  def collection?
-    false
+  def load(parent, options)
+
+    # Merge Options
+    options.reverse_merge!(self.options)
+
+    # Authorize and Set Path
+    association = authorize(options[:authorize]).with_path(parent, options[:path])
+
+    # Load Collection or Instance
+    collection? ? association.load_collection(parent) : association.load_instance(parent)
+  end
+
+  def load_collection(parent, association_class = self.association_class)
+    raise Restly::Error::AssociationError, "Not a collection" unless collection?
+    Restly::Proxies::Associations::Collection.new(association_class.all, parent)
+  end
+
+  def load_instance(parent, association_class = self.association_class)
+    raise Restly::Error::AssociationError, "Not an instance" if collection?
+    instance = if (foreign_key = parent.attributes["#{name}_id"])
+                 association_class.find(foreign_key)
+               else
+                 association_class.instance_from_response association_class.connection.get(association_class.path)
+               end
+    Restly::Proxies::Associations::Instance.new(instance, parent)
+  end
+
+  def valid?(val)
+    valid_instances = Array.wrap(val).reject{ |item| item.resource_name == @association_class.resource_name }.empty?
+    raise Restly::Error::InvalidObject, "#{val} is not a #{association_class}" unless valid_instances
+  end
+
+  # Stubs
+  def stub(parent, attributes)
+    return nil if !parent.is_a?(Restly::Base) || !attributes.present?
+    collection? ? stub_collection(parent, attributes) : stub_instance(parent, attributes)
+  end
+
+  def stub_collection(parent, attributes)
+    collection = attributes.map{ |item_attrs| association_class.new(item_attrs, loaded: embedded?) }
+    Restly::Proxies::Associations::Collection.new(collection, parent)
+  end
+
+  def stub_instance(parent, attributes)
+    instance = association_class.new(attributes, loaded: embedded?)
+    Restly::Proxies::Associations::Instance.new(instance, parent)
+  end
+
+  # Build
+  def build(parent, attributes = nil, options = {})
+    raise NoMethodError, "Build not available for collection." if collection?
+    instance = association_class.new(attributes, options)
+    instance.write_attribute("#{@owner.resource_name}_id", parent.id) if association_class.method_defined?("#{@owner.resource_name}_id")
+    Restly::Proxies::Associations::Instance.new(instance, parent)
+  end
+
+  # Modifiers
+  def authorize(authorization = nil, association_class=self.association_class)
+    duplicate = self.dup
+    duplicate.instance_variable_set :@association_class, if (!association_class.authorized? && @owner.respond_to?(:authorized?) && @owner.authorized?) || authorization
+                                                           association_class.authorize(authorization || @owner.connection)
+                                                         else
+                                                           association_class
+                                                         end
+    duplicate
   end
 
-  def build(*args)
-    new_instance = @association_class.new(*args)
-    new_instance.write_attribute("#{@owner.resource_name}_id") if @association_class.respond_to?("#{@owner.resource_name}_id") && !self.class.send(:reflect_on_resource_association, :custom_pages).embedded?
-    new_instance
+  def with_path(parent, path = nil, association_class=self.association_class)
+    duplicate = self.dup
+    duplicate.instance_variable_set :@association_class, if path
+                                                           association_class.with_path(path)
+                                                         else
+                                                           association_class.with_path(association_resource_name, prepend: parent.path)
+                                                         end
+    duplicate
   end
 
   private
 
-  def authorize(klass, authorization = nil)
-    if (!klass.authorized? && @owner.respond_to?(:authorized?) && @owner.authorized?) || authorization
-      klass.authorize(authorization || @owner.connection)
-    else
-      klass
-    end
+  def collection?
+    false
+  end
+
+  def embedded?
+    false
+  end
+
+  def association_resource_name
+    collection? ? association_class.resource_name.pluralize : association_class.resource_name
   end
 
 end

data/lib/restly/associations/belongs_to.rb

@@ -1,11 +1,28 @@
 class Restly::Associations::BelongsTo < Restly::Associations::Base
 
-  def find_with_parent(parent, options)
-    options.reverse_merge!(self.options)
-    association_class = polymorphic ? [@namespace, instance.send("#{name}_type")] : self.association_class
-    association_class = authorize(association_class, options[:authorize])
-    instance = association_class.find(parent.attributes["#{name}_id"])
-    Restly::Proxies::Associations::Instance.new(instance, parent)
+  def load(parent, options)
+    if polymorphic
+      set_polymorphic_class(parent).load(parent, options)
+    else
+      super(parent, options)
+    end
+  end
+
+  def set_polymorphic_class(parent)
+    duplicate = self.dup
+    duplicate.instance_variable_set(:@association_class, parent.send("#{name}_type"))
+    duplicate.instance_variable_set(:@polymorphic, false)
+    duplicate
+  end
+
+  def with_path(parent, path = nil, association_class=self.association_class)
+    duplicate = self.dup
+    duplicate.instance_variable_set :@association_class, if path
+                                                           association_class.with_path(path)
+                                                         else
+                                                           association_class
+                                                         end
+    duplicate
   end
 
   def collection?

data/lib/restly/associations/embeddable_resources/embeds_many.rb

@@ -4,4 +4,8 @@ class Restly::Associations::EmbeddableResources::EmbedsMany < Restly::Associatio
     true
   end
 
+  def embedded?
+    true
+  end
+
 end

data/lib/restly/associations/embeddable_resources/embeds_one.rb

@@ -4,4 +4,8 @@ class Restly::Associations::EmbeddableResources::EmbedsOne < Restly::Association
     false
   end
 
+  def embedded?
+    true
+  end
+
 end

data/lib/restly/associations/embeddable_resources.rb

@@ -10,9 +10,15 @@ module Restly::Associations::EmbeddableResources
     exclude_field(name) if ancestors.include?(Restly::Base)
     self.resource_associations[name] = association = EmbedsOne.new(self, name, options)
 
-    define_method name do
-      association.build(attributes[name])
+    define_method name do |options={}|
+      return get_association(name) if get_association(name).present?
+      set_association name, association.stub(self)
     end
+
+    define_method "#{name}=" do |value|
+      set_association name, value
+    end
+
   end
 
   # Embeds Many
@@ -20,9 +26,14 @@ module Restly::Associations::EmbeddableResources
     exclude_field(name) if ancestors.include?(Restly::Base)
     self.resource_associations[name] = association = EmbedsMany.new(self, name, options)
 
-    define_method name do
-      ( self.attributes[name] || [] ).map!{ |i| association.build(i) }
+    define_method name do |options={}|
+      get_association(name, options)
     end
+
+    define_method "#{name}=" do |value|
+      set_association name, value
+    end
+
   end
 
 end

data/lib/restly/associations/has_many.rb

@@ -7,15 +7,6 @@ class Restly::Associations::HasMany < Restly::Associations::Base
     super
   end
 
-  def scope_with_parent(parent, options)
-    options.reverse_merge!(self.options)
-    association_class = polymorphic ? [@namespace, instance.send("#{name}_type")] : self.association_class
-    association_class = authorize(association_class, options[:authorize])
-    collection = association_class.with_params("with_#{parent.resource_name}_id" => parent.id).all # (parent.attributes["#{name}_id"])
-    collection.select{|i| i.attributes["#{parent.resource_name}_id"] == parent.id }
-    Restly::Proxies::Associations::Collection.new(collection, parent)
-  end
-
   def collection?
     true
   end

data/lib/restly/associations/has_one.rb

@@ -7,15 +7,6 @@ class Restly::Associations::HasOne < Restly::Associations::Base
     super
   end
 
-  def scope_with_parent(parent, options)
-    options.reverse_merge!(self.options)
-    association_class = polymorphic ? [@namespace, instance.send("#{name}_type")] : self.association_class
-    association_class = authorize(association_class, options[:authorize])
-    collection = association_class.with_params("with_#{parent.resource_name}_id" => parent.id).all(parent.attributes["#{name}_id"])
-    collection.select{|i| i.attributes["#{parent.resource_name}_id"] == parent.id }.first
-    Restly::Proxies::Associations::Instance.new(instance, parent)
-  end
-
   def collection?
     true
   end

data/lib/restly/associations.rb

@@ -10,17 +10,30 @@ module Restly::Associations
   autoload :HasOneThrough
   autoload :EmbeddableResources
 
-  class AssociationHash < HashWithIndifferentAccess
+  class AssociationsSet < HashWithIndifferentAccess
+  end
+
+  class IndifferentSet < Set
+
+    def include?(attr)
+      return super unless attr.is_a?(Symbol) || attr.is_a?(String)
+      super(attr.to_s) || super(attr.to_sym)
+    end
+
   end
 
   included do
 
-    extend EmbeddableResources if self == Restly::Base
+    include Restly::ConcernedInheritance
+    extend  EmbeddableResources if self == Restly::Base
     include Restly::NestedAttributes
 
     delegate :resource_name, to: :klass
     class_attribute :resource_associations, instance_reader: false, instance_writer: false
-    self.resource_associations = AssociationHash.new
+
+    attr_reader :association_attributes
+
+    self.resource_associations = AssociationsSet.new
 
     inherited do
       self.resource_associations = resource_associations.dup
@@ -28,12 +41,42 @@ module Restly::Associations
 
   end
 
-  def stub_associations_from_response(response=self.response)
-    parsed = response.parsed || {}
-    parsed = parsed[resource_name] if parsed.is_a?(Hash) && parsed[resource_name]
-    associations = parsed.select{ |i| klass.reflect_on_all_resource_associations.keys.include?(i) }
-    associations.each do |relationship|
-      relationship.collection?
+  def associations
+    IndifferentSet.new klass.reflect_on_all_resource_associations.keys.map(&:to_sym)
+  end
+
+  def set_association(attr, val)
+    association = klass.reflect_on_resource_association(attr)
+    association.valid?(val)
+    @association_attributes[attr] = val
+  end
+
+  def get_association(attr, options={})
+    association = klass.reflect_on_resource_association(attr)
+    (@association_attributes ||= {}.with_indifferent_access)[attr] || set_association(attr, association.load(self, options))
+  end
+
+  def respond_to_association?(m)
+    !!(/(?<attr>\w+)(?<setter>=)?$/ =~ m.to_s) && associations.include?(attr.to_sym)
+  end
+
+  def respond_to?(m, include_private = false)
+    respond_to_association?(m) || super
+  end
+
+  private
+
+  def method_missing(m, *args, &block)
+    if !!(/(?<attr>\w+)(?<setter>=)?$/ =~ m.to_s) && associations.include?(m)
+      attr = attr.to_sym
+      case !!setter
+        when true
+          set_association(attr, *args)
+        when false
+          get_association(attr)
+      end
+    else
+      super(m, *args, &block)
     end
   end
 
@@ -47,6 +90,10 @@ module Restly::Associations
       name.gsub(/.*::/,'').underscore
     end
 
+    def reflect_on_resource_association(association_name)
+      reflect_on_all_resource_associations[association_name]
+    end
+
     def reflect_on_all_resource_associations
       resource_associations
     end
@@ -57,32 +104,45 @@ module Restly::Associations
     def belongs_to_resource(name, options = {})
       exclude_field(name) if ancestors.include?(Restly::Base)
       self.resource_associations[name] = association = BelongsTo.new(self, name, options)
+
       define_method name do |options={}|
-        association.find_with_parent(self, options)
+        get_association(name, options)
+      end
+
+      define_method "#{name}=" do |value|
+        set_association name, value
       end
+
     end
 
     # Has One
     def has_one_resource(name, options = {})
       exclude_field(name) if ancestors.include?(Restly::Base)
       self.resource_associations[name] = association = HasOne.new(self, name, options)
+
       define_method name do |options={}|
-        association.scope_with_parent(self, options)
+        get_association(name, options)
+      end
+
+      define_method "#{name}=" do |value|
+        set_association name, value
       end
+
     end
 
     # Has One
     def has_many_resources(name, options = {})
       exclude_field(name) if ancestors.include?(Restly::Base)
       self.resource_associations[name] = association = HasMany.new(self, name, options)
+
       define_method name do |options={}|
-        association.scope_with_parent(self, options)
+        get_association(name, options)
       end
-    end
 
+      define_method "#{name}=" do |value|
+        set_association name, value
+      end
 
-    def reflect_on_resource_association(association_name)
-      reflect_on_all_resource_associations[association_name]
     end
 
   end

data/lib/restly/base/generic_methods.rb

@@ -1,11 +1,15 @@
 module Restly::Base::GenericMethods
 
   def authorize(token_object)
-    Restly::Proxies::Auth.new self, token_object
+    Restly::Proxies::Authorization.new self, token_object
   end
 
   def with_params(params={})
-    Restly::Proxies::Params.new self, params
+    Restly::Proxies::WithParams.new self, params
+  end
+
+  def with_path(*args)
+    Restly::Proxies::WithPath.new self, *args
   end
 
   def path_with_format(*args)
@@ -21,4 +25,8 @@ module Restly::Base::GenericMethods
     connection.token.present?
   end
 
+  def proxied?
+    true
+  end
+
 end

data/lib/restly/base/includes.rb

@@ -1,18 +1,6 @@
 module Restly::Base::Includes
   extend ActiveSupport::Concern
 
-  included do
-    extend ClassMethods
-
-    class_attribute :inherited_callbacks
-    self.inherited_callbacks  =   []
-
-    inherited do
-      self.inherited_callbacks = inherited_callbacks
-    end
-
-  end
-
   module ClassMethods
 
     # Delegate stuff to client
@@ -38,16 +26,6 @@ module Restly::Base::Includes
       resource_name
     end
 
-    private
-
-    def inherited(subclass = nil, &block)
-      self.inherited_callbacks << block and return if block_given?
-
-      inherited_callbacks.each do |call_block|
-        subclass.class_eval(&call_block)
-      end
-    end
-
   end
 
 end