logical_model 0.5.8 → 0.5.10

data/README.rdoc

@@ -9,6 +9,8 @@ It was written following this tutorial: http://www.slideshare.net/ihower/service
 
 == Assumptions
 
+OUTDATED -- some of this assumpitions are now configurable. Will update this readme as soon as possible.
+
 LogicalModel makes some assumptions about the service you'll be consuming
 
 * resource service is RESTfull

data/VERSION

@@ -1 +1 @@
-0.5.8
+0.5.10

data/lib/logical_model.rb

@@ -9,8 +9,7 @@ require 'logical_model/responses_configuration'
 require 'logical_model/rest_actions'
 require 'logical_model/url_helper'
 require 'logical_model/safe_log'
-require 'logical_model/has_many_keys'
-require 'logical_model/belongs_to'
+require 'logical_model/associations'
 require 'logical_model/api_key'
 require 'logical_model/attributes'
 
@@ -59,8 +58,7 @@ class LogicalModel
   include LogicalModel::UrlHelper
   include LogicalModel::ApiKey
   include LogicalModel::SafeLog
-  include LogicalModel::HasManyKeys
-  include LogicalModel::BelongsTo
+  include LogicalModel::Associations
 
   # include ActiveModel Modules that are usefull
   extend ActiveModel::Naming

data/lib/logical_model/associations.rb

@@ -0,0 +1,11 @@
+require 'logical_model/associations/has_many_keys'
+require 'logical_model/associations/belongs_to'
+
+class LogicalModel
+  module Associations
+    def self.included(base)
+      base.send :include, LogicalModel::Associations::HasManyKeys
+      base.send :include, LogicalModel::Associations::BelongsTo
+    end
+  end
+end

data/lib/logical_model/associations/belongs_to.rb

@@ -0,0 +1,67 @@
+class LogicalModel
+  module Associations
+    module BelongsTo
+
+      def self.included(base)
+        base.send(:extend, ClassMethods)
+      end
+
+      module ClassMethods
+        # @param key [String] association name
+        # @param options [Hash]
+        # @option options [String/Constant] class
+        def belongs_to(key, options = {})
+          attr_accessor "#{key}_id"
+          attr_class = get_attr_class(key, options)
+
+          define_method("#{key}=") do |param|
+            if param.is_a?(Hash)
+              param.stringify_keys!
+              instance_variable_set("@#{key}_id", param['id']) if param['id']
+              instance = attr_class.new(param)
+            elsif param.is_a?(attr_class)
+              instance_variable_set("@#{key}_id", param.id)
+              instance = param
+            else
+              # ...
+            end
+
+            instance_variable_set("@#{key}",instance)
+          end
+
+          define_method(key) do
+            instance = eval("@#{key}")
+            if instance.nil?
+              instance = attr_class.find(eval("#{key}_id"))
+              instance_variable_set("@#{key}",instance)
+            end
+            instance
+          end
+
+          # TODO define_method("#{key}_attribute="){|param| ... }
+
+          define_method "new_#{key}" do |param|
+            attr_class
+
+            return unless attr_class
+
+            temp_object = attr_class.new(param.merge({"#{self.json_root}_id" => self.id}))
+            eval(key.to_s) << temp_object
+            temp_object
+          end
+        end
+
+        private
+
+        def get_attr_class(key, options)
+          if options[:class]
+            attr_class = options[:class].is_a?(String) ? options[:class].constantize : options[:class]
+          else
+            attr_class = key.to_s.singularize.camelize.constantize
+          end
+          attr_class
+        end
+      end
+    end
+    end
+end

data/lib/logical_model/associations/has_many_keys.rb

@@ -0,0 +1,83 @@
+class LogicalModel
+  module Associations
+    module HasManyKeys
+
+      def self.included(base)
+        base.send(:extend, ClassMethods)
+      end
+
+      module ClassMethods
+
+        def has_many(key)
+          @has_many_keys ||= []
+          @has_many_keys << key
+          has_many_keys = @has_many_keys
+        end
+
+        def has_many_keys=(keys)
+          @has_many_keys = keys
+          attr_accessor *keys
+
+          keys.each do |association|
+
+            # return empty array or @association variable for each association
+            define_method association do
+              if instance_variable_get("@#{association}").blank?
+                instance_variable_set("@#{association}", [])
+              end
+
+              instance_variable_get("@#{association}")
+            end
+
+            # this method loads the contact attributes recieved by logical model from the service
+            define_method "#{association}=" do |params|
+              collection = []
+              params.each do |attr_params|
+                if attr_params["_type"].present?
+                  attr_class = attr_params.delete("_type").to_s.constantize
+                else
+                  attr_class = association.to_s.singularize.camelize.constantize
+                end
+                collection << attr_class.new(attr_params)
+              end
+              instance_variable_set("@#{association}", collection)
+            end
+
+            define_method "new_#{association.to_s.singularize}" do |attr_params|
+              if attr_params["_type"].present?
+                clazz = attr_params.delete(:_type).constantize
+              else
+                clazz = association.to_s.singularize.camelize.constantize
+              end
+
+              return unless clazz
+
+              temp_object = clazz.new(attr_params.merge({"#{self.json_root}_id" => self.id}))
+              eval(association.to_s) << temp_object
+              temp_object
+            end
+
+            # this method loads the contact attributes from the html form (using nested resources conventions)
+            define_method "#{association}_attributes=" do |key_attributes|
+              array = []
+              key_attributes.each do |attr_params|
+                attr_params.to_hash.symbolize_keys!
+                if attr_params["_type"].present?
+                  attr_class = attr_params.delete("_type").to_s.constantize
+                else
+                  attr_class = association.to_s.singularize.camelize.constantize
+                end
+                array << attr_class.new(attr_params)
+              end
+              instance_variable_set("@#{association}", array)
+            end
+          end
+        end
+
+        def has_many_keys
+          @has_many_keys
+        end
+      end
+    end
+  end
+end

data/lib/logical_model/rest_actions.rb

@@ -171,6 +171,17 @@ class LogicalModel
 
       attr_accessor :enable_delete_multiple
 
+      # @param header [Hash]
+      def set_default_headers(header)
+        @headers = header
+      end
+
+      # User specified default headers
+      # @return [Hash]
+      def default_headers
+        @headers
+      end
+
       #  ============================================================================================================
       #  Following methods are API specific.
       #  They assume we are using a RESTfull API.
@@ -184,7 +195,7 @@ class LogicalModel
       # @param options [Hash] will be forwarded to API
       def async_all(options={})
         options = self.merge_key(options)
-        request = Typhoeus::Request.new(resource_uri, :params => options)
+        request = Typhoeus::Request.new(resource_uri, params: options, headers: default_headers)
         request.on_complete do |response|
           if response.code >= 200 && response.code < 400
             log_ok(response)
@@ -235,7 +246,7 @@ class LogicalModel
 
         options = self.merge_key(options)
 
-        request = Typhoeus::Request.new(resource_uri, :params => options)
+        request = Typhoeus::Request.new(resource_uri, params: options, headers: default_headers)
         request.on_complete do |response|
           if response.code >= 200 && response.code < 400
             log_ok(response)
@@ -296,7 +307,7 @@ class LogicalModel
 
         options = self.merge_key(options)
 
-        request = Typhoeus::Request.new(resource_uri, :params => options)
+        request = Typhoeus::Request.new(resource_uri, params: options, headers: default_headers)
         request.on_complete do |response|
           if response.code >= 200 && response.code < 400
             log_ok(response)

data/lib/logical_model/url_helper.rb

@@ -62,15 +62,14 @@ class LogicalModel
         (use_ssl?)? "https://" : "http://"
       end
 
-      # Returns true if ssl is recommended according to environment.
+      # Returns true if ssl is recommended
       #
-      # - production, staging -> true
-      # - other -> false
+      # - requests to localhost -> false
+      # - other -> true
       #
       # @return [Boolean]
       def ssl_recommended?
-        ssl_recommended_environments = %W(production staging)
-        ssl_recommended_environments.include?(defined?(Rails)? Rails.env : ENV['RACK_ENV'] )
+        (@host && !(@host =~ /localhost/))
       end
 
       # Requests done within the block will go to new path.

data/logical_model.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "logical_model"
-  s.version = "0.5.8"
+  s.version = "0.5.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dwayne Macgowan"]
-  s.date = "2013-07-12"
+  s.date = "2013-11-08"
   s.description = "LogicalModel allows to use a resource as a model. It is based on web presentation http://www.slideshare.net/ihower/serviceoriented-design-and-implement-with-rails3"
   s.email = "dwaynemac@gmail.com"
   s.extra_rdoc_files = [
@@ -34,9 +34,10 @@ Gem::Specification.new do |s|
     "db/migrate/001_create_users.rb",
     "lib/logical_model.rb",
     "lib/logical_model/api_key.rb",
+    "lib/logical_model/associations.rb",
+    "lib/logical_model/associations/belongs_to.rb",
+    "lib/logical_model/associations/has_many_keys.rb",
     "lib/logical_model/attributes.rb",
-    "lib/logical_model/belongs_to.rb",
-    "lib/logical_model/has_many_keys.rb",
     "lib/logical_model/hydra.rb",
     "lib/logical_model/responses_configuration.rb",
     "lib/logical_model/rest_actions.rb",

data/spec/client_spec.rb

@@ -27,42 +27,6 @@ describe "LogicalModel User client" do
     end
   end
 
-  describe "belongs_to :account" do
-    before do
-      class Account < LogicalModel
-        attribute :id
-        attribute :name
-      end
-      class User < LogicalModel
-        belongs_to :account
-      end
-
-      @account = Account.new(id: 1, name: 'asdf')
-      Account.stub(:find).with(1).and_return(@account)
-    end
-    it "responds to account_id" do
-      User.new.should respond_to :account_id
-    end
-    it "responds to account" do
-      User.new.should respond_to :account
-    end
-    it "allows to set association_id=x" do
-      u = User.new
-      u.account_id = 1
-      u.account.should == @account
-    end
-    it "allows to set association=Object" do
-      u = User.new
-      u.account = @account
-      u.account_id.should == 1
-    end
-    it "allows to set association=AttributesHash" do
-      u = User.new
-      u.account = {id: 3, name: 'account_name'}
-      u.account.should be_a Account
-      u.account.name.should == 'account_name'
-    end
-  end
 
   describe "RESTActions" do
     %W(find async_find paginate async_paginate delete delete_multiple).each do |class_action|
@@ -70,11 +34,53 @@ describe "LogicalModel User client" do
     end
   end
 
-  describe "has_many_keys" do
-    it { should respond_to 'has_many_keys=' }
-    it { should respond_to 'has_many_keys'}
+  describe "associations" do
+    describe "belongs_to :account" do
+      before do
+        class Account < LogicalModel
+          attribute :id
+          attribute :name
+        end
+        class User < LogicalModel
+          belongs_to :account
+        end
+
+        @account = Account.new(id: 1, name: 'asdf')
+        Account.stub(:find).with(1).and_return(@account)
+      end
+      it "responds to account_id" do
+        User.new.should respond_to :account_id
+      end
+      it "responds to account" do
+        User.new.should respond_to :account
+      end
+      it "allows to set association_id=x" do
+        u = User.new
+        u.account_id = 1
+        u.account.should == @account
+      end
+      it "allows to set association=Object" do
+        u = User.new
+        u.account = @account
+        u.account_id.should == 1
+      end
+      it "allows to set association=AttributesHash" do
+        u = User.new
+        u.account = {id: 3, name: 'account_name'}
+        u.account.should be_a Account
+        u.account.name.should == 'account_name'
+      end
+    end
+
+    describe "has_many_keys" do
+      it { should respond_to 'has_many_keys=' }
+      it { should respond_to 'has_many_keys'}
+    end
+
+
   end
 
+
   describe "url_helper" do
     it { should respond_to 'use_ssl=' }
     it { should respond_to 'use_ssl?' }
@@ -88,6 +94,17 @@ describe "LogicalModel User client" do
         User.use_ssl?.should be_true
       end
     end
+    describe "ssl_recommended?" do
+      it "returns false for localhost domains" do
+        User.host.should == "localhost:3000"
+        User.ssl_recommended?.should be_false
+      end
+      it "returns true for other domains" do
+        class User; set_resource_host("new_host"); end;
+        User.host.should == "new_host"
+        User.ssl_recommended?.should be_true
+      end
+    end
     describe "set_resource_host" do
       it { should respond_to 'set_resource_host' }
       it "sets resource_path" do
@@ -423,4 +440,4 @@ describe "LogicalModel User client" do
     end
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logical_model
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.5.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -341,9 +341,10 @@ files:
 - db/migrate/001_create_users.rb
 - lib/logical_model.rb
 - lib/logical_model/api_key.rb
+- lib/logical_model/associations.rb
+- lib/logical_model/associations/belongs_to.rb
+- lib/logical_model/associations/has_many_keys.rb
 - lib/logical_model/attributes.rb
-- lib/logical_model/belongs_to.rb
-- lib/logical_model/has_many_keys.rb
 - lib/logical_model/hydra.rb
 - lib/logical_model/responses_configuration.rb
 - lib/logical_model/rest_actions.rb
@@ -372,7 +373,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 77340669
+      hash: 449501073
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/logical_model/belongs_to.rb

@@ -1,65 +0,0 @@
-class LogicalModel
-  module BelongsTo
-
-    def self.included(base)
-      base.send(:extend, ClassMethods)
-    end
-
-    module ClassMethods
-      # @param key [String] association name
-      # @param options [Hash]
-      # @option options [String/Constant] class
-      def belongs_to(key, options = {})
-        attr_accessor "#{key}_id"
-        attr_class = get_attr_class(key, options)
-
-        define_method("#{key}=") do |param|
-          if param.is_a?(Hash)
-            param.stringify_keys!
-            instance_variable_set("@#{key}_id", param['id']) if param['id']
-            instance = attr_class.new(param)
-          elsif param.is_a?(attr_class)
-            instance_variable_set("@#{key}_id", param.id)
-            instance = param
-          else
-            # ...
-          end
-
-          instance_variable_set("@#{key}",instance)
-        end
-
-        define_method(key) do
-          instance = eval("@#{key}")
-          if instance.nil?
-            instance = attr_class.find(eval("#{key}_id"))
-            instance_variable_set("@#{key}",instance)
-          end
-          instance
-        end
-
-        # TODO define_method("#{key}_attribute="){|param| ... }
-
-        define_method "new_#{key}" do |param|
-          attr_class
-
-          return unless attr_class
-
-          temp_object = attr_class.new(param.merge({"#{self.json_root}_id" => self.id}))
-          eval(key.to_s) << temp_object
-          temp_object
-        end
-      end
-
-      private
-
-      def get_attr_class(key, options)
-        if options[:class]
-          attr_class = options[:class].is_a?(String) ? options[:class].constantize : options[:class]
-        else
-          attr_class = key.to_s.singularize.camelize.constantize
-        end
-        attr_class
-      end
-    end
-  end
-end

data/lib/logical_model/has_many_keys.rb

@@ -1,81 +0,0 @@
-class LogicalModel
-  module HasManyKeys
-
-    def self.included(base)
-      base.send(:extend, ClassMethods)
-    end
-
-    module ClassMethods
-
-      def has_many(key)
-        @has_many_keys ||= []
-        @has_many_keys << key
-        has_many_keys = @has_many_keys
-      end
-
-      def has_many_keys=(keys)
-        @has_many_keys = keys
-        attr_accessor *keys
-
-        keys.each do |association|
-
-          # return empty array or @association variable for each association
-          define_method association do
-            if instance_variable_get("@#{association}").blank?
-              instance_variable_set("@#{association}", [])
-            end
-
-            instance_variable_get("@#{association}")
-          end
-
-          # this method loads the contact attributes recieved by logical model from the service
-          define_method "#{association}=" do |params|
-            collection = []
-            params.each do |attr_params|
-              if attr_params["_type"].present?
-                attr_class = attr_params.delete("_type").to_s.constantize
-              else
-                attr_class = association.to_s.singularize.camelize.constantize
-              end
-              collection << attr_class.new(attr_params)
-            end
-            instance_variable_set("@#{association}", collection)
-          end
-
-          define_method "new_#{association.to_s.singularize}" do |attr_params|
-            if attr_params["_type"].present?
-              clazz = attr_params.delete(:_type).constantize
-            else
-              clazz = association.to_s.singularize.camelize.constantize
-            end
-
-            return unless clazz
-
-            temp_object = clazz.new(attr_params.merge({"#{self.json_root}_id" => self.id}))
-            eval(association.to_s) << temp_object
-            temp_object
-          end
-
-          # this method loads the contact attributes from the html form (using nested resources conventions)
-          define_method "#{association}_attributes=" do |key_attributes|
-            array = []
-            key_attributes.each do |attr_params|
-              attr_params.to_hash.symbolize_keys!
-              if attr_params["_type"].present?
-                attr_class = attr_params.delete("_type").to_s.constantize
-              else
-                attr_class = association.to_s.singularize.camelize.constantize
-              end
-              array << attr_class.new(attr_params)
-            end
-            instance_variable_set("@#{association}", array)
-          end
-        end
-      end
-
-      def has_many_keys
-        @has_many_keys
-      end
-    end
-  end
-end