popit 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be92d4476e37c35a6236ea9f814bdf3b665efa5d
+  data.tar.gz: ba44a8334452d04c0907bc5f934cd9c2b9fac26f
+SHA512:
+  metadata.gz: 6979c38dff96ae579396283a793e9830cdc6e846ec8398ba191b31fbc973c0cb28428080f66181bff2ee6ea4d729e4350bd4147fa37a52ae83800221330c7c77
+  data.tar.gz: 7522a5c1e5c5f6e16aab8646fa0f4447c3f4524e0c54a1de5380327a22b1a08022a97b308a2a81ea1f69635864e79926587bddbc0172066d7638ac294f71fc94

data/.travis.yml

@@ -1,3 +1,16 @@
+---
 language: ruby
 rvm:
-  - 1.9.3
+- 1.8.7
+- 1.9.2
+- 1.9.3
+- 2.0.0
+- ree
+env:
+  global:
+  - TRAVIS_SECURE_ENV_VARS: true
+  - secure: ! 'Q1wjuxr364WRXFTDD8jdunJG59Xl2iYFtehm+5d6UAR9mY9Ohv4TLqT6QhHu
+
+      1mdR575m90w3y1ZuS3NnzoUiMcrL+Osoza/tzBOch0+doXMqCXyZcgnSlNgV
+
+      16TcY+GFYbBnGnlq+5UoBCjOb3eqHdWqoASdT4DPIijGmvEzBDs='

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--hide-void-return
+--embed-mixin ClassMethods
+--markup=markdown

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in scraperwiki-api.gemspec
+# Specify your gem's dependencies in the gemspec
 gemspec

data/README.md

@@ -1,9 +1,11 @@
 # The PopIt API Ruby Gem
 
-A Ruby wrapper for the [PopIt](http://popit.mysociety.org/) API, which allows you to create, read, update and delete items from PopIt.
+A Ruby wrapper for the [PopIt](http://popit.mysociety.org/) API, which allows you to create, read, update and delete documents from PopIt.
 
+[![Build Status](https://secure.travis-ci.org/opennorth/popit-ruby.png)](http://travis-ci.org/opennorth/popit-ruby)
 [![Dependency Status](https://gemnasium.com/opennorth/popit-ruby.png)](https://gemnasium.com/opennorth/popit-ruby)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/opennorth/popit-ruby)
+[![Coverage Status](https://coveralls.io/repos/opennorth/popit-ruby/badge.png?branch=master)](https://coveralls.io/r/opennorth/popit-ruby)
+[![Code Climate](https://codeclimate.com/github/opennorth/popit-ruby.png)](https://codeclimate.com/github/opennorth/popit-ruby)
 
 ## Installation
 
@@ -28,11 +30,11 @@ You can pass these options to `PopIt.new`:
 * `:instance_name` the PopIt instance, usually the first part of the domain name
 * `:host_name` the PopIt API's host name – defaults to "popit.mysociety.org"
 * `:port` the PopIt API's port – defaults to 80
-* `:version` the PopIt API version – defaults to "v1"
+* `:version` the PopIt API version – defaults to "v0.1"
 * `:user` a user name – if blank, the API will be read-only
 * `:password` the user's password
 
-For brevity, we only show examples below for `person` items, but you can use the same code to operate on organisations and positions by substituting `organisation` or `position` for `person`.
+For brevity, we only show examples below for `persons` documents, but you can use the same code to operate on organizations and memberships by substituting `organizations` or `memberships` for `persons`.
 
 More documentation at [RubyDoc.info](http://rdoc.info/gems/popit/PopIt).
 
@@ -41,42 +43,38 @@ More documentation at [RubyDoc.info](http://rdoc.info/gems/popit/PopIt).
 Get all people:
 
 ```ruby
-response = api.person.get
-p response['results']
+api.persons.get
 ```
 
 Get one person:
 
 ```ruby
-response = api.person('47cc67093475061e3d95369d').get
-p response['result']
+api.persons('47cc67093475061e3d95369d').get
 ```
 
 You can also search for...
 
 * people by slug, name or summary
-* organisations by slug or name
-* positions by title, person or organisation
+* organizations by slug or name
+* memberships by title, person or organization
 
 For example:
 
 ```ruby
-response = api.person.get :name => 'John Doe'
-p response['results']
+api.person.get :name => 'John Doe'
 ```
 
 ### Create
 
 ```ruby
 response = api.person.post :name => 'John Doe'
-id = response['result']['_id']
+id = response['id']
 ```
 
 ### Update
 
 ```ruby
-response = api.person(id).put :name => 'Jane Doe'
-p response['result']
+api.person(id).put :id => id, :name => 'Jane Doe'
 ```
 
 ### Delete
@@ -87,29 +85,24 @@ success = api.person(id).delete
 
 ## Error Handling
 
-If you attempt to:
+You will raise a `PopIt::PageNotFound` exception if you attempt to access an instance, API version, collection or document that doesn't exist. You will raise a `PopIt::NotAuthenticated` exception if you attempt to create, update or delete a document without authenticating. In other error cases, you will raise a generic `PopIt::Error` exception.
 
-* read an item that doesn't exist
-* create, update or delete an item without authenticating
-* operate on something other than people, organisations and positions
-
-you will raise a `PopIt::Error` exception. The exception's message will be the same as from the PopIt API.
+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::Error with {"error":"page not found"}
+api.person.get 'foo' # raises PopIt::PageNotFound with "page not found"
 ```
 
 ## Running Tests
 
-To run the tests, create a `spec_auth.yml` file in the `spec` directory with the contents:
+To run the tests:
 
-```yml
-instance_name: YOUR_TEST_INSTANCE
-user: YOUR_USERNAME
-password: YOUR_PASSWORD
-```
+    export INSTANCE_NAME=YOUR_POPIT_INSTANCE_NAME
+    export POPIT_USER=YOUR_POPIT_EMAIL_ADDRESS
+    export POPIT_PASSWORD=YOUR_POPIT_PASSWORD
+    bundle exec rake
 
 **If you care about the data in an instance, do not use that instance to run tests!**
 

data/lib/popit/version.rb

@@ -1,3 +1,3 @@
 class PopIt
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/popit.rb

@@ -1,5 +1,4 @@
 require 'httparty'
-require 'yajl'
 
 # A Ruby wrapper for the PopIt API.
 #
@@ -8,11 +7,11 @@ require 'yajl'
 #
 #     require 'popit'
 #     api = PopIt.new :instance_name => 'demo'
-#     api.get 'person/john-doe'
+#     api.get 'persons/john-doe'
 #
 # can be written as:
 #
-#     api.person('john-doe').get
+#     api.persons('john-doe').get
 #
 # All methods and arguments between `api` and the HTTP method - in this case,
 # `get` - become parts of the path.
@@ -20,17 +19,30 @@ require 'yajl'
 # @see https://github.com/mysociety/popit/blob/master/lib/apps/api/api_v1.js
 class PopIt
   class Error < StandardError; end
+  class PageNotFound < Error; end
+  class NotAuthenticated < Error; end
 
   include HTTParty
 
-  attr_reader :instance_name, :host_name, :port, :version, :username, :password
+  # The instance name.
+  attr_reader :instance_name
+  # The PopIt API's host name, eg "popit.mysociety.org".
+  attr_reader :host_name
+  # The PopIt API's port, eg 80
+  attr_reader :port
+  # The PopIt API version, eg "v0.1"
+  attr_reader :version
+  # A user name.
+  attr_reader :username
+  # The user's password.
+  attr_reader :password
 
   # Initializes a PopIt API client.
   #
   # @param [Hash] opts the API client's configuration
   # @option opts [String] :instance_name the instance name
   # @option opts [String] :host_name the PopIt API's host name, eg "popit.mysociety.org"
-  # @option opts [String] :post the PopIt API's port, eg "80"
+  # @option opts [String] :post the PopIt API's port, eg 80
   # @option opts [String] :version the PopIt API version, eg "v1"
   # @option opts [String] :user a user name
   # @option opts [String] :password the user's password
@@ -41,13 +53,13 @@ class PopIt
 
     @instance_name = opts[:instance_name]
     @host_name     = opts[:host_name] || 'popit.mysociety.org'
-    @port          = opts[:port]
-    @version       = opts[:version]   || 'v1'
+    @port          = opts[:port]      || 80
+    @version       = opts[:version]   || 'v0.1'
     @username      = opts[:user]
     @password      = opts[:password]
   end
 
-  # Send a GET request.
+  # Sends a GET request.
   #
   # @param [String] path a path with no leading slash
   # @param [Hash] opts key-value pairs for the query string
@@ -56,7 +68,7 @@ class PopIt
     request :get, path, opts
   end
 
-  # Send a POST request.
+  # Sends a POST request.
   #
   # @param [String] path a path with no leading slash
   # @param [Hash] opts key-value pairs for the message body
@@ -65,7 +77,7 @@ class PopIt
     request :post, path, opts
   end
 
-  # Send a PUT request.
+  # Sends a PUT request.
   #
   # @param [String] path a path with no leading slash
   # @param [Hash] opts key-value pairs for the message body
@@ -74,7 +86,7 @@ class PopIt
     request :put, path, opts
   end
 
-  # Send a DELETE request.
+  # Sends a DELETE request.
   #
   # @param [String] path a path with no leading slash
   # @param [Hash] opts key-value pairs for the query string
@@ -97,16 +109,23 @@ private
       self.class.send http_method, path, :basic_auth => {:username => username, :password => password}, :body => opts
     end
 
-    unless ['200', '201', '204'].include? response.response.code
-      message = if response.response.content_type == 'text/html'
-        response.response.code
+    unless ['200', '201', '204'].include?(response.response.code)
+      if response.response.content_type == 'text/html'
+        message = response.response.code
       else
-        response.response.body
+        message = response.parsed_response['error'] || response.parsed_response['errors'].join(', ')
+      end
+      case response.response.code
+      when '404'
+        raise PopIt::PageNotFound, message
+      when '401'
+        raise PopIt::NotAuthenticated, message
+      else
+        raise PopIt::Error, message
       end
-      raise PopIt::Error, message
     end
 
-    response.parsed_response
+    response.parsed_response && response.parsed_response['result']
   end
 
   def method_missing(*args)

data/popit.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "popit/version"
+require File.expand_path('../lib/popit/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "popit"
@@ -11,14 +10,15 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/opennorth/popit-ruby"
   s.summary     = %q{The PopIt API Ruby Gem}
   s.description = %q{A Ruby wrapper for the PopIt API}
+  s.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency('yajl-ruby', '~> 1.0')
-  s.add_runtime_dependency('httparty', '~> 0.8.0')
+  s.add_runtime_dependency('httparty', '~> 0.10.0')
   s.add_development_dependency('rspec', '~> 2.10')
   s.add_development_dependency('rake')
+  s.add_development_dependency('coveralls')
 end

data/spec/popit_spec.rb

@@ -11,88 +11,99 @@ describe PopIt do
   end
 
   let :authenticated do
-    PopIt.new YAML.load_file(File.expand_path(File.dirname(__FILE__) + '/spec_auth.yml'))
+    PopIt.new({
+      :instance_name => ENV['INSTANCE_NAME'] || 'tttest',
+      :user          => ENV['POPIT_USER'] || 'james@opennorth.ca',
+      :password      => ENV['POPIT_PASSWORD'],
+    })
   end
 
   it 'should fail to send a request to a bad instance' do
     api = PopIt.new :instance_name => '47cc67093475061e3d95369d'
-    expect { api.person.get }.to raise_error(PopIt::Error, '404')
+    expect { api.persons.get }.to raise_error(PopIt::PageNotFound, '404')
   end
 
   it 'should fail to send a request to a bad version' do
     api = PopIt.new :instance_name => 'tttest', :version => 'v0'
-    expect { api.person.get }.to raise_error(PopIt::Error, '{"error":"page not found"}')
+    expect { api.persons.get }.to raise_error(PopIt::PageNotFound, 'page not found')
   end
 
   context 'with a PopIt instance' do
-    before :all do
-      @person = authenticated.person.post(:name => 'John Doe', :slug => 'john-doe')['result']
-    end
-
     let :person do
-      @person
+      unauthenticated.persons.get(:name => 'Foo', :slug => 'foo')[0]
     end
 
     let :id do
-      @person['_id']
+      person['id']
     end
 
     it 'should fail to send a request to a bad schema' do
-      expect { unauthenticated.foo.get }.to raise_error(PopIt::Error, '{"error":"page not found"}')
+      expect { unauthenticated.foo.get }.to raise_error(PopIt::PageNotFound, "collection 'foo' not found")
     end
 
     context 'when unauthenticated' do
       it 'should get all items' do
-        response = unauthenticated.person.get
-        results = response['results']
-        results.should be_an(Array)
+        response = unauthenticated.persons.get
+        response.should be_an(Array)
       end
 
       it 'should get one item by name' do
-        response = unauthenticated.person.get :name => 'John Doe'
-        results = response['results']
-        results.should be_an(Array)
+        response = unauthenticated.persons.get :name => 'Foo'
+        response.should be_an(Array)
       end
 
       it 'should get one item' do
-        response = unauthenticated.person(id).get
-        result = response['result']
-        result.should == person
+        response = unauthenticated.persons(id).get
+        # PopIt adds fields e.g. __v, _internal, contact_details, images, links,
+        # other_names, personal_details and adds positions_api_url to meta.
+        person.each do |k,v|
+          unless k == 'meta'
+            response[k].should == v
+          end
+        end
       end
 
       it 'should fail to get a non-existent item' do
-        expect { unauthenticated.person('foo').get }.to raise_error(PopIt::Error, '{"error":"page not found"}')
+        expect {unauthenticated.persons('bar').get}.to raise_error(PopIt::PageNotFound, "id 'bar' not found")
       end
 
       it 'should fail to create an item' do
-        expect {unauthenticated.person.post :name => 'John Doe', :slug => 'john-doe'}.to raise_error(PopIt::Error, %({"error":"not authenticated"}))
+        expect {unauthenticated.persons.post :name => 'John Doe', :slug => 'john-doe'}.to raise_error(PopIt::NotAuthenticated, 'not authenticated')
       end
 
       it 'should fail to update an item' do
-        expect {unauthenticated.person(id).put :name => 'Jane Doe'}.to raise_error(PopIt::Error, %({"error":"not authenticated"}))
+        expect {unauthenticated.persons(id).put :id => id, :name => 'John Doe', :slug => 'john-doe'}.to raise_error(PopIt::NotAuthenticated, 'not authenticated')
       end
 
       it 'should fail to delete an item' do
-        expect {unauthenticated.person(id).delete}.to raise_error(PopIt::Error, %({"error":"not authenticated"}))
+        expect {unauthenticated.persons(id).delete}.to raise_error(PopIt::NotAuthenticated, 'not authenticated')
       end
     end
 
     context 'when authenticated' do
-      it 'should create an item' do
-        response = authenticated.person.post :name => 'John Smith'
-        result = response['result']
-        result['name'].should == 'John Smith'
-        authenticated.person(result['_id']).delete # cleanup
-      end
-
-      it 'should update an item' do
-        response = authenticated.person(id).put :name => 'John Smith'
+      it 'should create, update and delete an item' do
+        response = authenticated.persons.post :name => 'John Smith', :slug => 'john-smith'
+        id = response['id']
+        response['name'].should == 'John Smith'
+
+        response = authenticated.persons(id).put :id => id, :name => 'John Doe', :slug => 'john-doe'
+        response.should == {
+          'id'              => id,
+          'name'            => 'John Doe',
+          'slug'            => 'john-doe',
+          'memberships'     => [],
+          'links'           => [],
+          'contact_details' => [],
+          'identifiers'     => [],
+          'other_names'     => [],
+          'url'             => 'http://tttest.popit.mysociety.org/api/v0.1/persons/' + id,
+          'html_url'        => 'http://tttest.popit.mysociety.org/persons/john-doe',
+        }
+        authenticated.persons(id).get['name'].should == 'John Doe'
+
+        response = authenticated.persons(id).delete
         response.should == nil
-      end
-
-      it 'should delete an item' do
-        response = authenticated.person(id).delete
-        response.should == {}
+        expect {authenticated.persons(id).get}.to raise_error(PopIt::PageNotFound, "id '#{id}' not found")
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,3 +1,7 @@
 require 'rubygems'
+
+require 'coveralls'
+Coveralls.wear!
+
 require 'rspec'
 require File.dirname(__FILE__) + '/../lib/popit'

metadata

@@ -1,78 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: popit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Open North
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-28 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yajl-ruby
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
-  type: :runtime
+        version: '2.10'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '2.10'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A Ruby wrapper for the PopIt API
@@ -84,6 +75,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE
 - README.md
@@ -95,30 +87,29 @@ files:
 - spec/popit_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/opennorth/popit-ruby
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: The PopIt API Ruby Gem
 test_files:
 - spec/popit_spec.rb
 - spec/spec_helper.rb
-has_rdoc: