logical_model 0.4.10 → 0.5.0

data/lib/logical_model/safe_log.rb

@@ -0,0 +1,61 @@
+require 'logger'
+
+class LogicalModel
+  module SafeLog
+
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+      base.send(:extend, ClassMethods)
+    end
+
+    module InstanceMethods
+      def log_ok(response)
+        self.class.log_ok(response)
+      end
+
+      def log_failed(response)
+        self.class.log_failed(response)
+      end
+
+    end
+
+    module ClassMethods
+      attr_accessor :log_path
+
+      def log_path
+        @log_path ||= "log/logical_model.log"
+      end
+
+      def log_ok(response)
+        self.logger.info("LogicalModel Log: #{response.code} #{mask_api_key(response.effective_url)} in #{response.time}s")
+        self.logger.debug("LogicalModel Log RESPONSE: #{response.body}")
+      end
+
+      def log_failed(response)
+        begin
+          error_message = ActiveSupport::JSON.decode(response.body)["message"]
+        rescue => e
+          error_message = "error"
+        end
+        msg = "LogicalModel Log: #{response.code} #{mask_api_key(response.effective_url)} in #{response.time}s FAILED: #{error_message}"
+        self.logger.warn(msg)
+        self.logger.debug("LogicalModel Log RESPONSE: #{response.body}")
+      end
+
+      def logger
+        Logger.new(self.log_path || "log/logical_model.log")
+      end
+
+      # Filters api_key
+      # @return [String]
+      def mask_api_key(str)
+        if use_api_key && str
+          str = str.gsub(api_key,'[SECRET]')
+        end
+        str
+      end
+
+    end
+
+  end
+end

data/lib/logical_model/url_helper.rb

@@ -0,0 +1,78 @@
+class LogicalModel
+  module UrlHelper
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    # adds following setters
+    # - force_ssl
+    # - set_resource_host
+    # - set_resource_path
+    #
+    # add reader
+    # - resource_uri
+    module ClassMethods
+
+      attr_accessor :host,
+                    :resource_path,
+                    :use_ssl
+
+      # Will return path to resource
+      # @param id [String] (nil)
+      def resource_uri(id=nil)
+        sufix  = (id.nil?)? "" : "/#{id}"
+        "#{url_protocol_prefix}#{host}#{resource_path}#{sufix}"
+      end
+
+      # If called in class, will make al request through SSL.
+      # @example
+      #   class Client < LogicalModel
+      #     force_ssl
+      #     ...
+      #   end
+      def force_ssl
+        @use_ssl = true
+      end
+
+      # @param new_host [String] resource host. Should NOT include protocol (http)
+      # @param new_path [String] resource path in host
+      def set_resource_url(new_host,new_path)
+        @host = new_host
+        @resource_path = new_path
+      end
+
+      def set_resource_host(new_host)
+        @host = new_host
+      end
+
+      def set_resource_path(new_path)
+        @resource_path = new_path
+      end
+
+      ##
+      # Default use_ssl to ssl_recommend?
+      # @return [Boolean]
+      def use_ssl?
+        @use_ssl ||= ssl_recommended?
+      end
+
+      # @return [String]
+      def url_protocol_prefix
+        (use_ssl?)? "https://" : "http://"
+      end
+
+      # Returns true if ssl is recommended according to environment.
+      #
+      # - production, staging -> true
+      # - other -> false
+      #
+      # @return [Boolean]
+      def ssl_recommended?
+        ssl_recommended_environments = %W(production staging)
+        ssl_recommended_environments.include?(defined?(Rails)? Rails.env : ENV['RACK_ENV'] )
+      end
+    end
+
+  end
+end

data/logical_model.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "logical_model"
-  s.version = "0.4.10"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dwayne Macgowan"]
-  s.date = "2013-04-23"
+  s.date = "2013-05-01"
   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 = [
@@ -32,9 +32,12 @@ Gem::Specification.new do |s|
     "db/development.sqlite3",
     "db/migrate/001_create_users.rb",
     "lib/logical_model.rb",
+    "lib/logical_model/api_key.rb",
+    "lib/logical_model/attributes.rb",
     "lib/logical_model/has_many_keys.rb",
-    "lib/safe_log.rb",
-    "lib/ssl_support.rb",
+    "lib/logical_model/rest_actions.rb",
+    "lib/logical_model/safe_log.rb",
+    "lib/logical_model/url_helper.rb",
     "lib/typhoeus_fix/array_decoder.rb",
     "logical_model.gemspec",
     "models/user.rb",

data/spec/client_spec.rb

@@ -5,6 +5,135 @@ include TyphoeusMocks
 
 describe "LogicalModel User client" do
 
+  subject{User}
+
+  describe "Attributes" do
+    subject{User.new}
+    %W(id name email password bio).each do |attribute|
+      it { should respond_to attribute }
+      it { should respond_to "#{attribute}="}
+    end
+    describe "attribute definer" do
+      it "should add attribute" do
+        User.new.attributes.should_not include :this_is_a_new_attribute
+        User.new.attributes.should_not include :another_new_attribute
+        class User < LogicalModel
+          attribute :this_is_a_new_attribute
+          attribute :another_new_attribute
+        end
+        User.new.attributes.should include :this_is_a_new_attribute
+        User.new.attributes.should include :another_new_attribute
+      end
+    end
+  end
+
+  describe "RESTActions" do
+    %W(find async_find paginate async_paginate delete delete_multiple).each do |class_action|
+      it { should respond_to class_action }
+    end
+  end
+
+  describe "has_many_keys" do
+    it { should respond_to 'has_many_keys=' }
+    it { should respond_to 'has_many_keys'}
+  end
+
+  describe "url_helper" do
+    it { should respond_to 'use_ssl=' }
+    it { should respond_to 'use_ssl?' }
+    it { should respond_to 'url_protocol_prefix' }
+    it { should respond_to 'ssl_recommended?' }
+    describe "force_ssl" do
+      it { should respond_to 'force_ssl' }
+      it "sets use_ssl to true" do
+        User.use_ssl?.should be_false
+        class User; force_ssl; end;
+        User.use_ssl?.should be_true
+      end
+    end
+    describe "set_resource_host" do
+      it { should respond_to 'set_resource_host' }
+      it "sets resource_path" do
+        User.resource_path.should == "/api/v1/users"
+        class User; set_resource_path("new_path"); end;
+        User.resource_path.should == "new_path"
+      end
+    end
+    describe "set_resource_path" do
+      it { should respond_to 'set_resource_path'}
+      it "sets resource_host" do
+        User.host.should == "localhost:3000"
+        class User; set_resource_host("new_host"); end;
+        User.host.should == "new_host"
+      end
+    end
+  end
+
+  describe "safe_log" do
+    it { should respond_to 'log_ok' }
+    it { should respond_to 'log_failed' }
+    it { should respond_to 'logger' }
+    it { should respond_to 'mask_api_key' }
+    describe ".log_path" do
+      it { should respond_to 'log_path' }
+      its(:log_path){ should == "logs/development.log"}
+    end
+  end
+
+  describe "api_key" do
+    describe "set_api_key" do
+      it { should respond_to 'set_api_key'}
+      it "sets api_key" do
+        class User < LogicalModel
+          set_api_key(:key_name, 'secret_api_key')
+        end
+        User.use_api_key.should be_true
+        User.api_key.should == 'secret_api_key'
+        User.api_key_name.should == :key_name
+      end
+    end
+    describe "use_api_key" do
+      it { should respond_to 'use_api_key' }
+      context "when true" do
+        before(:each) do
+          class User < LogicalModel; self.use_api_key=true; self.api_key_name='keyname'; self.api_key="secret_api_key"; end
+        end
+        it "should send api key in requests" do
+          Typhoeus::Request.should_receive(:new).with(User.resource_uri(1),{:params=>{'keyname'=>'secret_api_key'}})
+          begin
+            User.find(1)
+          rescue
+          end
+        end
+        it "should mask api key in logs" do
+          response = mock(
+              code: 200,
+              body: {}.to_json,
+              effective_url: "server?keyname=secret_api_key",
+              time: 1234
+          )
+          Logger.any_instance.should_receive(:info).with(/\[SECRET\]/)
+          User.log_ok(response)
+          Logger.any_instance.should_receive(:warn).with(/\[SECRET\]/)
+          User.log_failed(response)
+        end
+      end
+      context "when false" do
+        before(:each) do
+          class User < LogicalModel; self.use_api_key=false; self.api_key_name='keyname'; self.api_key="secret_api_key"; end
+        end
+        it "should not send api key in requests" do
+          Typhoeus::Request.should_not_receive(:new).with(User.resource_uri(1),{:params=>{'keyname'=>'secret_api_key'}})
+          begin
+            User.find(1)
+          rescue
+          end
+        end
+      end
+    end
+    it { should respond_to 'merge_key'}
+  end
+
   describe "#create" do
     context "with valid attributes" do
       context "if response is code 201" do
@@ -131,45 +260,6 @@ describe "LogicalModel User client" do
     end
   end
 
-  describe "use_api_key" do
-    context "when true" do
-      before(:each) do
-        class User < LogicalModel; self.use_api_key=true; self.api_key_name='keyname'; self.api_key="secret_api_key"; end
-      end
-      it "should send api key in requests" do
-        Typhoeus::Request.should_receive(:new).with(User.resource_uri(1),{:params=>{'keyname'=>'secret_api_key'}})
-        begin
-          User.find(1)
-        rescue
-        end
-      end
-      it "should mask api key in logs" do
-        response = mock(
-            code: 200,
-            body: {}.to_json,
-            effective_url: "server?keyname=secret_api_key",
-            time: 1234
-        )
-        Logger.any_instance.should_receive(:info).with(/\[SECRET\]/)
-        User.log_ok(response)
-        Logger.any_instance.should_receive(:warn).with(/\[SECRET\]/)
-        User.log_failed(response)
-      end
-    end
-    context "when false" do
-      before(:each) do
-        class User < LogicalModel; self.use_api_key=false; self.api_key_name='keyname'; self.api_key="secret_api_key"; end
-      end
-      it "should not send api key in requests" do
-        Typhoeus::Request.should_not_receive(:new).with(User.resource_uri(1),{:params=>{'keyname'=>'secret_api_key'}})
-        begin
-          User.find(1)
-        rescue
-        end
-      end
-    end
-  end
-
   describe "#https" do
     context "when use_ssl is tue" do
       before(:each) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logical_model
 version: !ruby/object:Gem::Version
-  version: 0.4.10
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -323,9 +323,12 @@ files:
 - db/development.sqlite3
 - db/migrate/001_create_users.rb
 - lib/logical_model.rb
+- lib/logical_model/api_key.rb
+- lib/logical_model/attributes.rb
 - lib/logical_model/has_many_keys.rb
-- lib/safe_log.rb
-- lib/ssl_support.rb
+- lib/logical_model/rest_actions.rb
+- lib/logical_model/safe_log.rb
+- lib/logical_model/url_helper.rb
 - lib/typhoeus_fix/array_decoder.rb
 - logical_model.gemspec
 - models/user.rb
@@ -348,7 +351,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -711400131
+      hash: 863618749
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/safe_log.rb

@@ -1,11 +0,0 @@
-module SafeLog
-
-  # Filters api_key
-  # @return [String]
-  def mask_api_key(str)
-    if use_api_key && str
-      str = str.gsub(api_key,'[SECRET]')
-    end
-    str
-  end
-end

data/lib/ssl_support.rb

@@ -1,39 +0,0 @@
-module SslSupport
-
-  def self.included(base)
-    base.class.send(:attr_accessor, :use_ssl)
-    base.send(:include, InstanceMethods)
-    base.send(:extend, ClassMethods)
-  end
-
-  module InstanceMethods
-
-  end
-
-  module ClassMethods
-    ##
-    # Default use_ssl to ssl_recommend?
-    # @return [Boolean]
-    def use_ssl?
-      @use_ssl ||= ssl_recommended?
-    end
-
-    # @return [String]
-    def url_protocol_prefix
-      (use_ssl?)? "https://" : "http://"
-    end
-
-    # Returns true if ssl is recommended according to environment.
-    #
-    # - production, staging -> true
-    # - other -> false
-    #
-    # @return [Boolean]
-    def ssl_recommended?
-      ssl_recommended_environments = %W(production staging)
-      ssl_recommended_environments.include?(defined?(Rails)? Rails.env : ENV['RACK_ENV'] )
-    end
-  end
-
-
-end