apify 0.4.3 → 0.4.4

data/README.md

@@ -59,7 +59,7 @@ If you are planning to consume your Apify API with the `Apify::Client` class, yo
 - API actions can take arguments. Those are serialized into a **single** HTTP parameter `args` as JSON. This is to simplify client code that consumes your API (nested params are hard).
 - Successful responses are returned with a status of 200 (OK).
 - The body of a successful response is always a hash, serialized as JSON.
-- Requests that have errors are returned with a status of 500 (internal server error). The body of a error response is an error message in the response's content type (won't be JSON in most cases).
+- Requests that have errors are returned with a status that is **not** 200. The body of a error response is an error message in the response's content type (won't be JSON in most cases).
 
 
 Defining API actions
@@ -210,7 +210,11 @@ Errors can be caught and inspected like this:
       puts "Response: #{e.response_body}"
     end
 
-An example for an API can be found under the `examples/client` directory inside the repository.
+Use the `:protocol` option to connect using SSL:
+
+    client = Apify::Client.new(:host => 'api.site.com', :user => 'api', :password => 'secret', :protocol => 'https')
+
+An example for an API client can be found under the `examples/client` directory inside the repository.
 
 
 Dealing with dates and timestamps

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.4.4

data/apify.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apify}
-  s.version = "0.4.3"
+  s.version = "0.4.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Henning Koch"]
-  s.date = %q{2010-08-29}
+  s.date = %q{2010-09-03}
   s.description = %q{Compact definition of JSON APIs for Rails applications. }
   s.email = %q{github@makandra.de}
   s.extra_rdoc_files = [

data/app/views/apify/api/_protocol.html.erb

@@ -19,7 +19,7 @@
 <ul>
   <li>Successful requests are returned with a status of 200 (OK).</li>
   <li>The body of a successful response is always a hash, serialized as JSON.</li>
-  <li>Requests that have errors are returned with a status of 500 (internal server error). The body of a error response is an error message in the response's content type (won't be JSON in most cases).</li>
+  <li>Requests that have errors are returned with a status that is <strong>not</strong> 200. The body of a error response is an error message in the response's content type (won't be JSON in most cases).</li>
   <li>You can download an example for a successful response value by appending <code>?example=value</code> to the action URL.</li>
   <li>You can download a <a href="http://json-schema.org/">JSON schema</a> for a successful response by appending <code>?schema=value</code> to the URL. The API guarantees that all responses conform to this schema.</li>
 </ul>

data/lib/apify/client.rb

@@ -35,8 +35,7 @@ module Apify
     
     def request(method, path, args = nil)
       url = build_url(path)
-      args ||= {}
-      params = { :args => args.to_json }
+      params = args ? { :args => args.to_json } : {}
       [:get, :head].include?(method) and params = { :params => params }
       json = RestClient.send(method, url, params)
       JSON.parse(json)

data/spec/apify/client_spec.rb

@@ -22,19 +22,40 @@ describe Apify::Client do
 
   it "should call API methods with arguments" do
     client = Apify::Client.new(:host => 'host')
-    stub_request(:post, 'http://host/api/hello').to_return(:status => 200, :body => '{}')
+    stub_request(:post, 'http://host/api/hello').to_return(:body => '{}')
     args = { :name => 'Jack' }
     client.post('/api/hello', args)
     WebMock.should have_requested(:post, "http://host/api/hello").with(:body => { :args => args.to_json })
   end
 
+  it 'should not transmit an args parameter if the arguments are blank' do
+    client = Apify::Client.new(:host => 'host')
+    stub_request(:get, 'http://host/api/ping').to_return(:body => '{}')
+    client.get('/api/ping')
+    WebMock.should have_requested(:get, "http://host/api/ping")
+  end
+
   it "should call GET actions correctly" do
     client = Apify::Client.new(:host => 'host')
     args = { :name => 'Jack' }
-    stub_request(:get, 'http://host/api/hello').with(:query => { :args => args.to_json }).to_return(:status => 200, :body => '{}')
+    stub_request(:get, 'http://host/api/hello').with(:query => { :args => args.to_json }).to_return(:body => '{}')
     client.get('/api/hello', args)
     WebMock.should have_requested(:get, "http://host/api/hello").with(:query => { :args => args.to_json })
   end
 
+  it "should connect using SSL" do
+    client = Apify::Client.new(:host => 'host', :protocol => 'https')
+    stub_request(:get, 'https://host/api/ping').to_return(:body => '{}')
+    client.get('/api/ping')
+    WebMock.should have_requested(:get, "https://host/api/ping")
+  end
+
+  it 'should allow to use a non-standard port' do
+    client = Apify::Client.new(:host => 'host', :port => '8080')
+    stub_request(:get, 'http://host:8080/api/ping').to_return(:body => '{}')
+    client.get('/api/ping')
+    WebMock.should have_requested(:get, "http://host:8080/api/ping")
+  end
+
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 3
-  version: 0.4.3
+  - 4
+  version: 0.4.4
 platform: ruby
 authors: 
 - Henning Koch
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-29 00:00:00 +02:00
+date: 2010-09-03 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency