mirage 3.0.0.alpha.6 → 3.0.0.alpha.7

data/README.md

@@ -39,6 +39,60 @@ if there was a more appropriate template.
 
 Litteral matchers are worth more in the scoring process than regex based ones for example.
 #### What's new in the Client:
+##### 1. Template Models
+Perhaps the biggest addition to the client. Simply mixin Mirage::Template::Model in to a class, give it a method called body and there you have it... a class that can be used to put objects straight on to Mirage.
+ 
+* All the methods you find on a standard response can then be used at the class level to set defaults. 
+ 
+* Add builder methods to your class using the builder_methods class method.
+ 
+**Example Usage:** (See rdoc for full details)  
+
+    class UserProfile
+      extend Mirage::Template::Model
+      
+      endpoint '/users'
+      http_method :get
+      status 200
+      content_type 'application/json'
+      
+      builder_methods :firstname, :lastname, :age
+      
+      def body
+        {firstname: firstname, lastname: lastname, age: age}.to_json
+      end
+    end
+    
+    
+    Mirage::Client.new.put UserProfile.new.firstname('Joe').lastname('blogs')
+    
+##### Client interface
+The client interface has been overhauled to make it more usable. It supports a couple of different ways of specifying a template
+to let to specify templates in the style that best suites your code. The block in the examples is executed in the scope of the template
+object itself so any method in it can be called. The template is also passed in to the block if you prefer to to call the methods
+on a variable.
+
+**Example Usage:** (See rdoc for full details)  
+
+    mirage = Mirage::Client.new
+    mirage.put('/users') do
+      status 201
+      http_method :put
+      body 'response'
+      
+      required_body_content << 'Abracadabra'
+      required_headers['Header'] = 'value'
+      
+      delay 1.5
+    end
+    
+    # Template Model classes can be customised in exactly the same way
+    
+    mirage.put UserProfile.new do
+      status 404
+      required_parameters[:name] = /joe.*/
+    end
+
 
 ### 2.4.0
 ---------

data/VERSION

@@ -1 +1 @@
-3.0.0.alpha.6
+3.0.0.alpha.7

data/lib/mirage/client/template.rb

@@ -12,6 +12,7 @@ module Mirage
 
     include HTTParty
     include Model::InstanceMethods
+    include Model::CommonMethods
 
     class << self
       alias_method :backedup_get, :get
@@ -41,5 +42,13 @@ module Mirage
         template
       end
     end
+
+    def initialize *args
+      endpoint = args.first
+
+      raise ArgumentError, "You must specify a string endpoint as the first argument" unless endpoint && endpoint.is_a?(String)
+      super *args
+
+    end
   end
 end

data/lib/mirage/client/template/model.rb

@@ -1,6 +1,5 @@
-
 require 'client/helpers/method_builder'
-require 'client/template/model/class_methods'
+require 'client/template/model/common_methods'
 require 'client/template/model/instance_methods'
 
 module Mirage
@@ -9,14 +8,31 @@ module Mirage
 
       class << self
         def extended clazz
-          clazz.extend(ClassMethods)
+          clazz.extend(CommonMethods)
+          clazz.extend(Helpers::MethodBuilder)
           clazz.send(:include, HTTParty)
+          clazz.send(:include, CommonMethods)
           clazz.send(:include, InstanceMethods)
 
+
           mod = Module.new do
             def initialize *args
-              super self.class.endpoint, ''
-              status self.class.status if self.class.status
+
+              super *args
+              [:content_type,
+               :http_method,
+               :default,
+               :status,
+               :delay,
+               :required_parameters,
+               :required_body_content,
+               :required_headers,
+               :headers,
+               :endpoint, :delay].each do |attribute|
+                eval("#{attribute} self.class.#{attribute} if self.class.#{attribute}")
+              end
+
+
             end
           end
 

data/lib/mirage/client/template/model/common_methods.rb

@@ -0,0 +1,26 @@
+module Mirage
+
+  class Template
+    module Model
+      module CommonMethods
+        extend Helpers::MethodBuilder
+
+        builder_methods :content_type,
+                        :http_method,
+                        :default,
+                        :status,
+                        :delay,
+                        :required_parameters,
+                        :required_body_content,
+                        :required_headers,
+                        :headers,
+                        :endpoint,
+                        :body
+
+        alias value body
+      end
+
+    end
+  end
+
+end

data/lib/mirage/client/template/model/instance_methods.rb

@@ -3,11 +3,17 @@ module Mirage
     module Model
       module InstanceMethods
         extend Helpers::MethodBuilder
+        include CommonMethods
 
-        def initialize endpoint, response, default_config=Template::Configuration.new
-          @endpoint = endpoint
+        def initialize *args
+          if args.last.is_a?(Template::Configuration)
+            default_config = args.delete_at(-1)
+          else
+            default_config = Template::Configuration.new
+          end
+
+          @endpoint, @body = *args
           @content_type = default_config.content_type
-          @value = response
           @http_method = default_config.http_method
           @status = default_config.status
           @delay = default_config.delay
@@ -18,20 +24,10 @@ module Mirage
           @default = default_config.default
         end
 
-        builder_method :content_type,
-                       :http_method,
-                       :default,
-                       :status,
-                       :delay,
-                       :required_parameters,
-                       :required_body_content,
-                       :required_headers,
-                       :endpoint,
-                       :id,
+        builder_method :id,
                        :url,
-                       :requests_url,
-                       :headers,
-                       :value
+                       :requests_url
+
 
         def create
           @id = self.class.put("#{@endpoint}", :body => self.to_json, :headers => {'content-type' => 'application/json'})['id']
@@ -47,7 +43,7 @@ module Mirage
         def to_json
           {
               :response => {
-                  :body => Base64.encode64(value),
+                  :body => Base64.encode64(body),
                   :status => status,
                   :default => default,
                   :content_type => content_type,

data/mirage.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mirage"
-  s.version = "3.0.0.alpha.6"
+  s.version = "3.0.0.alpha.7"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Leon Davis"]
-  s.date = "2013-04-28"
+  s.date = "2013-04-30"
   s.description = "Mirage aids testing of your applications by hosting mock responses so that your applications do not have to talk to real endpoints. Its accessible via HTTP and has a RESTful interface."
   s.executables = ["mirage"]
   s.extra_rdoc_files = [
@@ -65,7 +65,7 @@ Gem::Specification.new do |s|
     "lib/mirage/client/template.rb",
     "lib/mirage/client/template/configuration.rb",
     "lib/mirage/client/template/model.rb",
-    "lib/mirage/client/template/model/class_methods.rb",
+    "lib/mirage/client/template/model/common_methods.rb",
     "lib/mirage/client/template/model/instance_methods.rb",
     "lib/mirage/client/templates.rb",
     "mirage.gemspec",
@@ -87,7 +87,7 @@ Gem::Specification.new do |s|
     "spec/client/requests_spec.rb",
     "spec/client/runner_spec.rb",
     "spec/client/template/configuration_spec.rb",
-    "spec/client/template/model/class_methods_spec.rb",
+    "spec/client/template/model/common_methods_spec.rb",
     "spec/client/template/model/instance_methods_spec.rb",
     "spec/client/template/model_spec.rb",
     "spec/client/template_spec.rb",

data/spec/client/client_spec.rb

@@ -62,16 +62,18 @@ describe Mirage::Client do
       mirage.templates(1).should == mock_template
     end
 
-    it "should put a response on mirage by passing args on to template's put method "  do
-      endpoint, value, block = 'greeting', 'hello', Proc.new{}
+    describe 'put' do
+      it "should put a response on mirage by passing args on to template's put method "  do
+        endpoint, value, block = 'greeting', 'hello', Proc.new{}
 
-      templates_mock = mock('templates')
-      Templates.should_receive(:new).and_return(templates_mock)
+        templates_mock = mock('templates')
+        Templates.should_receive(:new).and_return(templates_mock)
 
       templates_mock.should_receive(:put).with(endpoint, value, &block)
 
-      mirage = Client.new
-      mirage.put endpoint, value, &block
+        mirage = Client.new
+        mirage.put endpoint, value, &block
+      end
     end
   end
 

data/spec/client/template/model/common_methods_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+describe 'CommonMethods' do
+  let!(:model) do
+    Class.new do
+      include Template::Model::CommonMethods
+    end
+  end
+
+  let!(:instance) do
+    model.new '', ''
+  end
+  it 'should provide methods for customising the model' do
+    instance.methods.should include(:content_type,
+                                    :http_method,
+                                    :default,
+                                    :status,
+                                    :delay,
+                                    :required_parameters,
+                                    :required_body_content,
+                                    :required_headers,
+                                    :endpoint,
+                                    :headers,
+                                    :body)
+  end
+end

data/spec/client/template/model/instance_methods_spec.rb

@@ -13,24 +13,15 @@ describe Template::Model::InstanceMethods do
     model.new '', ''
   end
 
-  it 'should provide methods for customising the model' do
-    instance.methods.should include(:content_type,
-                                 :http_method,
-                                 :default,
-                                 :status,
-                                 :delay,
-                                 :required_parameters,
-                                 :required_body_content,
-                                 :required_headers,
-                                 :endpoint,
-                                 :id,
-                                 :url,
-                                 :requests_url,
-                                 :headers,
-                                 :value)
-  end
 
   context 'initialize' do
+
+    it 'requires an endpoint' do
+      endpoint = 'value'
+      instance = model.new endpoint
+      instance.endpoint.should == endpoint
+    end
+
     it 'requires an endpoint and value to be provided' do
       endpoint, value = 'endpoint', 'value'
       instance = model.new endpoint, value
@@ -50,6 +41,12 @@ describe Template::Model::InstanceMethods do
       instance.http_method.should == config.http_method
       instance.status.should == config.status
       instance.default.should == config.default
+
+      instance = model.new 'endpoint', config
+      instance.content_type.should == config.content_type
+      instance.http_method.should == config.http_method
+      instance.status.should == config.status
+      instance.default.should == config.default
     end
   end
 

data/spec/client/template/model_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Template::Model do
-  let(:endpoint){'endpoint'}
+  let(:endpoint) { 'endpoint' }
   let!(:test_class) do
     Class.new do
       extend Template::Model
@@ -14,9 +14,13 @@ describe Template::Model do
     end
   end
   context 'class' do
-    it 'should extend ClassMethods and MethodBuilder' do
-      test_class.is_a?(Template::Model::ClassMethods).should == true
+    it 'should extend MethodBuilder and CommonMethods' do
       test_class.is_a?(Helpers::MethodBuilder).should == true
+      test_class.is_a?(Template::Model::CommonMethods).should == true
+    end
+
+    it 'should include Instance methods' do
+      test_class.is_a?(Template::Model::CommonMethods).should == true
     end
 
     context 'inherited constructor' do
@@ -47,24 +51,69 @@ describe Template::Model do
       test_class.ancestors.should include(HTTParty)
     end
 
-    it 'provides a method for customising the endpoint of all instances' do
-      endpoint = 'endpoint'
-      test_class.endpoint endpoint
-      test_class.new.endpoint.should == endpoint
-    end
+    describe 'defaults' do
+
+      it 'should be default the endpoint' do
+        endpoint = 'endpoint'
+        test_class.endpoint endpoint
+        test_class.new.endpoint.should == endpoint
+      end
 
-    describe 'default status' do
-      it 'sets the status of instances if set' do
+      it 'should be default the status' do
         status = 404
         test_class.status status
         test_class.new.status.should == status
       end
 
-      it 'status of instances retain the global default if status is not set at the class level' do
-        test_class.new.status.should == 200
+      it 'should be default the content-type' do
+        content_type = 'application/json'
+        test_class.content_type content_type
+        test_class.new.content_type.should == content_type
       end
 
+      it 'should be default the http_method' do
+        method = :post
+        test_class.http_method method
+        test_class.new.http_method.should == method
+      end
+
+      it 'should be default the default status' do
+        default = true
+        test_class.default default
+        test_class.new.default.should == default
+      end
+
+      it 'should be default the required parameters' do
+        required_parameters = {name: 'joe'}
+        test_class.required_parameters required_parameters
+        test_class.new.required_parameters.should == required_parameters
+      end
+
+      it 'should be default the required headers' do
+        headers = {name: 'joe'}
+        test_class.required_headers headers
+        test_class.new.required_headers.should == headers
+      end
+
+      it 'should be default the required body content' do
+        content = ['content']
+        test_class.required_body_content content
+        test_class.new.required_body_content.should == content
+      end
+
+      it 'should be default the headers' do
+        headers = {name: 'joe'}
+        test_class.headers headers
+        test_class.new.headers.should == headers
+      end
+
+      it 'should be default the delay' do
+        delay = 4
+        test_class.delay delay
+        test_class.new.delay.should == delay
+      end
     end
+
   end
 
 end

data/spec/client/template_spec.rb

@@ -66,6 +66,16 @@ describe Mirage::Template do
     end
   end
 
+  describe 'initialize' do
+    it 'throws and exception if an endpoint is not supplied as the first parameter' do
+      expect{Template.new}.to raise_error(ArgumentError)
+    end
+
+    it 'throws and exception if first argument is not a string' do
+      expect{Template.new(:endpoint)}.to raise_error(ArgumentError)
+    end
+  end
+
 
   describe 'creating' do
     json = "reponse json"

data/test.rb

@@ -1,50 +1,19 @@
 require './lib/mirage/client'
-#
-#class ServiceNowResponse
-#  extend Mirage::Template::Model
-#
-#  endpoint 'service_now'
-#
-#  builder_methods :this,:that
-#
-#  def value
-#    "my value : #{this}, #{that}"
-#  end
-#end
-#
-Mirage.stop
-mirage = Mirage.start
-#mirage.put ServiceNowResponse.new.this('foo').that('bar')
-#mirage.put ServiceNowResponse.new.this('foo').that('bar').required_body_content(%w(hello world))
-#mirage.put ServiceNowResponse.new.this('foo').that('bar').required_parameters({:name => 'leon'})
-
-require 'ostruct'
-class UserServiceProfile
+class UserProfile
   extend Mirage::Template::Model
 
-  endpoint 'Users'
+  endpoint '/users'
+  http_method :get
+  status 200
+  content_type 'application/json'
+  required_body_content %w(leon davis)
 
-  def initialize persona
-    super
-    required_parameters[:token] = persona.token
-    @persona = persona
-  end
+  builder_methods :firstname, :lastname, :age
 
-  def value
-    {name: @persona.name}.to_json
+  def body
+    {firstname: firstname, lastname: lastname, age: age}.to_json
   end
 end
 
-leon = OpenStruct.new(
-    :name => 'leon',
-    :token => '1234'
-)
-
-mirage.clear
-
-
-leons_user_profile = UserServiceProfile.new leon
-mirage.put leons_user_profile do
-  status 404
-  method :get
-end
+mirage = Mirage.start
+mirage.put UserProfile.new.firstname('leon').lastname('davis').age(30)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mirage
 version: !ruby/object:Gem::Version
-  version: 3.0.0.alpha.6
+  version: 3.0.0.alpha.7
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2013-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -294,7 +294,7 @@ files:
 - lib/mirage/client/template.rb
 - lib/mirage/client/template/configuration.rb
 - lib/mirage/client/template/model.rb
-- lib/mirage/client/template/model/class_methods.rb
+- lib/mirage/client/template/model/common_methods.rb
 - lib/mirage/client/template/model/instance_methods.rb
 - lib/mirage/client/templates.rb
 - mirage.gemspec
@@ -316,7 +316,7 @@ files:
 - spec/client/requests_spec.rb
 - spec/client/runner_spec.rb
 - spec/client/template/configuration_spec.rb
-- spec/client/template/model/class_methods_spec.rb
+- spec/client/template/model/common_methods_spec.rb
 - spec/client/template/model/instance_methods_spec.rb
 - spec/client/template/model_spec.rb
 - spec/client/template_spec.rb
@@ -349,7 +349,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2788995362471982437
+      hash: 817642380514883205
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/mirage/client/template/model/class_methods.rb

@@ -1,11 +0,0 @@
-module Mirage
-  class Template
-    module Model
-      module ClassMethods
-        extend Helpers::MethodBuilder
-        include Helpers::MethodBuilder
-        builder_method :endpoint, :status
-      end
-    end
-  end
-end

data/spec/client/template/model/class_methods_spec.rb

@@ -1,19 +0,0 @@
-require 'spec_helper'
-
-describe Template::Model::ClassMethods do
-  context 'class methods' do
-
-    it 'should provide a method for setting the endpoint for the class' do
-      endpoint = 'endpoint'
-      model_class = Class.new do
-        extend Template::Model::ClassMethods
-
-        endpoint endpoint
-      end
-
-      model_class.endpoint.should == endpoint
-    end
-
-  end
-
-end