apify 0.4.5 → 0.5.0

data/README.md

@@ -136,12 +136,15 @@ Here is another example for a more complex schema:
             'phone' => integer,
             'phone_type' => enum(string, 'home', 'office'),
             'email' => optional(email),
+            'website' => optional(url),
             'favorite' => boolean
           )
         )
       end
     end
 
+Note that the schema considers an key/value pair to be "present" when the key is present, even if the value is `nil`. That means if an object entry is optional and you want to omit that entry, you need to leave out the entire key/value pair.
+
 
 Auto-generated API documentation
 --------------------------------

data/VERSION

@@ -1 +1 @@
-0.4.5
+0.5.0

data/apify.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apify}
-  s.version = "0.4.5"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Henning Koch"]
-  s.date = %q{2010-10-18}
+  s.date = %q{2010-10-29}
   s.description = %q{Compact definition of JSON APIs for Rails applications. }
   s.email = %q{github@makandra.de}
   s.extra_rdoc_files = [
@@ -79,6 +79,7 @@ Gem::Specification.new do |s|
      "lib/apify/client.rb",
      "lib/apify/errors.rb",
      "lib/apify/exchange.rb",
+     "lib/apify/patterns.rb",
      "lib/apify/schema_helper.rb",
      "spec/apify/action_spec.rb",
      "spec/apify/client_spec.rb",

data/lib/apify.rb

@@ -2,6 +2,7 @@ require 'json'
 require 'jsonschema'
 
 require 'apify/errors'
+require 'apify/patterns'
 require 'apify/action'
 require 'apify/exchange'
 require 'apify/api'

data/lib/apify/patterns.rb

@@ -0,0 +1,10 @@
+module Apify
+  class Patterns
+
+    EMAIL = /\A[a-z0-9\+\-_\.]+@[a-z0-9]+[a-z0-9\-\.]*[a-z0-9]+\z/i
+    URL = /(http|https):\/\/[\w\-_]+(\.[\w\-_]+)*([\w\-\.,@?^=%&:\/~\+#]*[\w\-\@?^=%&\/~\+#])?/
+    SQL_DATE = /\A\d{4}-\d{2}-\d{2}\z/
+    SQL_DATETIME = /\A\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\z/
+
+  end
+end

data/lib/apify/schema_helper.rb

@@ -39,17 +39,22 @@ module Apify
 
     def sql_date
       { 'type' => 'string',
-        'pattern' => Patterns::SQL_DATE.source }
+        'pattern' => Apify::Patterns::SQL_DATE.source }
     end
 
     def sql_datetime
       { 'type' => 'string',
-        'pattern' => Patterns::SQL_DATETIME.source }
+        'pattern' => Apify::Patterns::SQL_DATETIME.source }
     end
 
     def email
       { 'type' => 'string',
-        'pattern' => Patterns::EMAIL.source }
+        'pattern' => Apify::Patterns::EMAIL.source }
+    end
+
+    def url
+      { 'type' => 'string',
+        'pattern' => Apify::Patterns::URL.source }
     end
 
   end

data/spec/app_root/app/models/api.rb

@@ -45,4 +45,28 @@ class Api < Apify::Api
     end
   end
 
+  get :schema_with_sql_date do
+    schema :args do
+      object('date' => sql_date)
+    end
+  end
+
+  get :schema_with_sql_datetime do
+    schema :args do
+      object('datetime' => sql_datetime)
+    end
+  end
+
+  get :schema_with_email do
+    schema :args do
+      object('email' => email)
+    end
+  end
+
+  get :schema_with_url do
+    schema :args do
+      object('url' => url)
+    end
+  end
+
 end

data/spec/controllers/api_controller_spec.rb

@@ -64,8 +64,11 @@ describe ApiController do
 
   describe 'argument schemas' do
 
-    it "should validate the presence of a property" do
+    before :each do
       instance_exec(&authenticate)
+    end
+
+    it "should validate the presence of a property" do
       post :with_args_schema, :args => {}.to_json
       response.code.should == '500'
       response.body.should include('Invalid request args')
@@ -73,7 +76,6 @@ describe ApiController do
     end
 
     it "should validate value types" do
-      instance_exec(&authenticate)
       post :with_args_schema, :args => {'string_arg' => 123}.to_json
       response.code.should == '500'
       response.body.should include('Invalid request args')
@@ -81,13 +83,11 @@ describe ApiController do
     end
 
     it "should allow requests that fit the schema" do
-      instance_exec(&authenticate)
       post :with_args_schema, :args => {'string_arg' => 'a string'}.to_json
       response.code.should == '200'
     end
 
     it "should render the schema if requested" do
-      instance_exec(&authenticate)
       post :with_args_schema, :schema => 'args'
       response.code.should == '200'
       JSON.parse(response.body).should == {
@@ -101,8 +101,11 @@ describe ApiController do
 
   describe 'value schemas' do
 
-    it "should validate the presence of a property" do
+    before :each do
       instance_exec(&authenticate)
+    end
+
+    it "should validate the presence of a property" do
       post :with_value_schema, :args => {}.to_json
       response.code.should == '500'
       response.body.should include('Invalid response value')
@@ -110,7 +113,6 @@ describe ApiController do
     end
 
     it "should validate value types" do
-      instance_exec(&authenticate)
       post :with_value_schema, :args => {'string_value' => 123}.to_json
       response.code.should == '500'
       response.body.should include('Invalid response value')
@@ -118,14 +120,12 @@ describe ApiController do
     end
 
     it "should return responses that fit the schema" do
-      instance_exec(&authenticate)
       post :with_value_schema, :args => {'string_value' => 'a string'}.to_json
       response.code.should == '200'
       JSON.parse(response.body).should == {'string_value' => 'a string'}
     end    
 
     it "should render the schema if requested" do
-      instance_exec(&authenticate)
       post :with_value_schema, :schema => 'value'
       response.code.should == '200'
       JSON.parse(response.body).should == {
@@ -137,6 +137,75 @@ describe ApiController do
 
   end
 
+  describe 'schema helpers' do
+
+    before :each do
+      instance_exec(&authenticate)
+    end
+
+    describe '#sql_date helper' do
+
+      it 'should match a date as seen in SQL' do
+        get :schema_with_sql_date, :args => {'date' => '2011-05-01'}.to_json
+        response.code.should == '200'
+      end
+
+      it 'should not match an invalid string' do
+        get :schema_with_sql_date, :args => {'date' => '01.05.2011'}.to_json
+        response.code.should == '500'
+      end
+
+    end
+
+    describe '#sql_datetime helper' do
+
+      it 'should match a timestamp as seen in SQL' do
+        get :schema_with_sql_datetime, :args => {'datetime' => '2011-05-01 12:10:59'}.to_json
+        response.code.should == '200'
+      end
+
+      it 'should not match an invalid string' do
+        get :schema_with_sql_datetime, :args => {'datetime' => '2011-05-01'}.to_json
+        response.code.should == '500'
+      end
+
+    end
+
+    describe '#email helper' do
+
+      it 'should match an email address' do
+        get :schema_with_email, :args => {'email' => 'some.guy@some.domain.tld'}.to_json
+        response.code.should == '200'
+      end
+
+      it 'should not match an invalid string' do
+        get :schema_with_email, :args => {'email' => 'some.guy'}.to_json
+        response.code.should == '500'
+      end
+
+    end
+
+    describe '#url_helper' do
+
+      it 'should match a http address' do
+        get :schema_with_url, :args => {'url' => 'http://some.domain.tld/path/to?query=value'}.to_json
+        response.code.should == '200'
+      end
+
+      it 'should match a https address' do
+        get :schema_with_url, :args => {'url' => 'https://some.domain.tld/path/to?query=value'}.to_json
+        response.code.should == '200'
+      end
+
+      it 'should not match an invalid string' do
+        get :schema_with_url, :args => {'url' => 'foo:bar:bam'}.to_json
+        response.code.should == '500'
+      end
+
+    end
+
+  end
+
   describe 'auto-generated documentation' do
     integrate_views
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: apify
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
   - 5
-  version: 0.4.5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Henning Koch
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-18 00:00:00 +02:00
+date: 2010-10-29 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -132,6 +132,7 @@ files:
 - lib/apify/client.rb
 - lib/apify/errors.rb
 - lib/apify/exchange.rb
+- lib/apify/patterns.rb
 - lib/apify/schema_helper.rb
 - spec/apify/action_spec.rb
 - spec/apify/client_spec.rb