popit 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1021ff7eac4c07cf92775b5dbf6332170cc19769
-  data.tar.gz: f0a647c2052715a33e8fc37a530dde2fba43b45c
+  metadata.gz: 7e0f5c6b92de48b6576028e879ce2ae23b648cbb
+  data.tar.gz: a178baf6cc337d0c44be75e73cff15aabafbf9e3
 SHA512:
-  metadata.gz: 9f0259be0579851787258054454f0b4913d4eb86a7e9df117f19e744e798e4e6153007e17e22912bf7fa24c695932638891cf6058a0e4e07236133ab7b7d59f9
-  data.tar.gz: 0f30f81ca79ae0a422718eb23a4d4eb793b90e63e1e8c8dbbb8631a9314139ecfad26c5ee992efea1fa0fb9c1e7e8b66f93b4dc27fe1ac55e098d73f47acdecb
+  metadata.gz: 91081f9cd938df6f9672cf45770e53007bea1067152d9e243d4e1ce5907840579dd68a092ada1cc6e32a7ef58fa03c0f1e8a6238bc9a18f14385f04a4b575274
+  data.tar.gz: 72ed49a72f1890dbc10bfd1cbd03a8197376e1dda7b85d7305d033cde8416b01b3a886fdfdad88262061ff5986ae692d018ed1f33d70151ca4a2f5f542ade131

data/README.md

@@ -22,7 +22,7 @@ require 'popit'
 Then, create an API client for PopIt:
 
 ```ruby
-api = PopIt.new :instance_name => 'demo'
+api = PopIt.new(:instance_name => 'demo')
 ```
 
 You can pass these options to `PopIt.new`:
@@ -40,47 +40,55 @@ More documentation at [RubyDoc.info](http://rdoc.info/gems/popit/PopIt).
 
 ### Read
 
-Get all people:
+Get one page of people (default 30 per page):
 
 ```ruby
 api.persons.get
 ```
 
+Get a different number of people per page (maximum 100 per page):
+
+```ruby
+api.persons.get(:per_page => 100)
+```
+
+Get another page of people:
+
+```ruby
+api.persons.get(:page => 2)
+```
+
 Get one person:
 
 ```ruby
 api.persons('47cc67093475061e3d95369d').get
 ```
 
-You can also search for...
-
-* people by slug, name or summary
-* organizations by slug or name
-* memberships by title, person or organization
+### Search
 
-For example:
+Read the [PopIt API documentation](http://popit.mysociety.org/docs/api/search) for details.
 
 ```ruby
-api.person.get :name => 'John Doe'
+api.search.persons.get(:q => 'name:"John Doe"')
 ```
 
 ### Create
 
 ```ruby
-response = api.person.post :name => 'John Doe'
+response = api.persons.post(:name => 'John Doe')
 id = response['id']
 ```
 
 ### Update
 
 ```ruby
-api.person(id).put :id => id, :name => 'Jane Doe'
+api.persons(id).put(:id => id, :name => 'Jane Doe')
 ```
 
 ### Delete
 
 ```ruby
-success = api.person(id).delete
+success = api.persons(id).delete
 ```
 
 ## Error Handling
@@ -91,8 +99,8 @@ The exception's message will be the same as from the PopIt API.
 
 ```ruby
 require 'popit'
-api = PopIt.new :instance_name => 'demo'
-api.person.get 'foo' # raises PopIt::PageNotFound with "page not found"
+api = PopIt.new(:instance_name => 'demo')
+api.persons.get('foo') # raises PopIt::PageNotFound with "page not found"
 ```
 
 ## Running Tests

data/lib/popit.rb

@@ -49,7 +49,7 @@ class PopIt
   # @option opts [String] :user a user name
   # @option opts [String] :password the user's password
   def initialize(opts = {})
-    unless opts.has_key? :instance_name
+    unless opts.has_key?(:instance_name)
       raise ArgumentError, 'Missing key :instance_name'
     end
 
@@ -67,7 +67,7 @@ class PopIt
   # @param [Hash] opts key-value pairs for the query string
   # @return the JSON response from the server
   def get(path, opts = {})
-    request :get, path, opts
+    request(:get, path, opts)
   end
 
   # Sends a POST request.
@@ -76,7 +76,7 @@ class PopIt
   # @param [Hash] opts key-value pairs for the message body
   # @return the JSON response from the server
   def post(path, opts = {})
-    request :post, path, opts
+    request(:post, path, opts)
   end
 
   # Sends a PUT request.
@@ -85,7 +85,7 @@ class PopIt
   # @param [Hash] opts key-value pairs for the message body
   # @return [nil] nothing
   def put(path, opts = {})
-    request :put, path, opts
+    request(:put, path, opts)
   end
 
   # Sends a DELETE request.
@@ -94,7 +94,7 @@ class PopIt
   # @param [Hash] opts key-value pairs for the query string
   # @return [Hash] an empty hash
   def delete(path, opts = {})
-    request :delete, path, opts
+    request(:delete, path, opts)
   end
 
 private
@@ -104,18 +104,22 @@ private
 
     response = case http_method
     when :get
-      self.class.send http_method, path, :query => opts
+      self.class.send(http_method, path, :query => opts)
     when :delete
-      self.class.send http_method, path, :basic_auth => {:username => username, :password => password}, :query => opts
+      self.class.send(http_method, path, :basic_auth => {:username => username, :password => password}, :query => opts)
     when :post, :put
-      self.class.send http_method, path, :basic_auth => {:username => username, :password => password}, :body => JSON.dump(opts), :headers => {'Content-Type' => 'application/json', 'Accept' => 'application/json'}
+      self.class.send(http_method, path, :basic_auth => {:username => username, :password => password}, :body => JSON.dump(opts), :headers => {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
     end
 
     unless ['200', '201', '204'].include?(response.response.code)
-      if response.response.content_type == 'text/html'
-        message = response.response.code
+      message = if response.response.content_type == 'text/html'
+        "HTTP #{response.response.code}"
+      elsif response.parsed_response['error']
+        response.parsed_response['error']
+      elsif response.parsed_response['errors']
+        response.parsed_response['errors'].join(', ')
       else
-        message = response.parsed_response['error'] || response.parsed_response['errors'].join(', ')
+        response.parsed_response
       end
       case response.response.code
       when '404'
@@ -143,19 +147,19 @@ private
     end
 
     def get(opts = {})
-      @klass.get chain.join('/'), opts
+      @klass.get(chain.join('/'), opts)
     end
 
     def post(opts = {})
-      @klass.post chain.join('/'), opts
+      @klass.post(chain.join('/'), opts)
     end
 
     def put(opts = {})
-      @klass.put chain.join('/'), opts
+      @klass.put(chain.join('/'), opts)
     end
 
     def delete(opts = {})
-      @klass.delete chain.join('/'), opts
+      @klass.delete(chain.join('/'), opts)
     end
 
     def method_missing(*args)

data/lib/popit/version.rb

@@ -1,3 +1,3 @@
 class PopIt
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/popit_spec.rb

@@ -82,8 +82,9 @@ describe PopIt do
 
     context 'when authenticated' do
       it 'should create, update and delete an item' do
-        response = authenticated.persons.post :name => 'John Smith', :slug => 'john-smith'
+        response = authenticated.persons.post :name => 'John Smith', :slug => 'john-smith', :contact_details => [{:type => 'email', :value => 'test@example.com'}]
         id = response['id']
+        contact_detail_id = response['contact_details'][0]['id']
         response['name'].should == 'John Smith'
 
         response = authenticated.persons(id).put :id => id, :name => 'John Doe', :slug => 'john-doe'
@@ -93,11 +94,15 @@ describe PopIt do
           'slug'            => 'john-doe',
           'memberships'     => [],
           'links'           => [],
-          'contact_details' => [],
+          'contact_details' => [{
+            'id'    => contact_detail_id,
+            'type'  => 'email',
+            'value' => 'test@example.com',
+          }],
           'identifiers'     => [],
           'other_names'     => [],
           'url'             => 'http://tttest.popit.mysociety.org/api/v0.1/persons/' + id,
-          'html_url'        => 'http://tttest.popit.mysociety.org/persons/john-doe',
+          'html_url'        => 'http://tttest.popit.mysociety.org/persons/' + id,
         }
         authenticated.persons(id).get['name'].should == 'John Doe'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: popit
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Open North
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty