popit 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e107fa8a67b9fb91253acc05db2c906befc9463
-  data.tar.gz: 5acea070cae8ef2839b9463406d0a8e00de81938
+  metadata.gz: 3bf9709f2c6a428a607fe1ad33b6c9b075047ed2
+  data.tar.gz: cd7f8c448ace3f050a8ba0c1b5a588d5b73ed0c7
 SHA512:
-  metadata.gz: 41a16756393b990c236499ca3ca00ca63ed2cfc1c564543212c1206b17e24d1432af99cc382e6383c2ab34128beceeb825b3dfafc71c4c0f6ed541f2ca77bd66
-  data.tar.gz: 6a5a620436db1c783ca726cb94d68968c80de9fdd9d523317b91398eeb9908936cc51cc5058338e2c9b08bdf579bb224a4dcef030ad3bb288fe0746ddacb23bc
+  metadata.gz: 024bb1ec703c7c84ba724806e3ba86a40954c16d3ef7ff3380787a9dcd02cdc724ffd7e4fa1d38441d941f91a4379cb9da7c1262aa490d64488e2526dd986f26
+  data.tar.gz: 5894ea311751bec451f96a10d386f9069fa20657ac8685a76dd104f40dc0725dc82549c1576221ae9a87e0ed78d6c78815f1c365ff7a83cbe8ce2a7509aeedc5

data/.travis.yml

@@ -1,14 +1,9 @@
----
 language: ruby
 rvm:
 - 1.9.2
 - 1.9.3
 - 2.0.0
+- 2.1.0
 env:
   global:
-  - TRAVIS_SECURE_ENV_VARS: true
-  - secure: ! 'Q1wjuxr364WRXFTDD8jdunJG59Xl2iYFtehm+5d6UAR9mY9Ohv4TLqT6QhHu
-
-      1mdR575m90w3y1ZuS3NnzoUiMcrL+Osoza/tzBOch0+doXMqCXyZcgnSlNgV
-
-      16TcY+GFYbBnGnlq+5UoBCjOb3eqHdWqoASdT4DPIijGmvEzBDs='
+    secure: OYhs6gJoC2eZr4H3uH9X1R36rxIj6ISiK8QO+tdhSxRyUZsKA94iYEqUsvb9jtyE+5NYlsWx/0SQdUQsRS06CIdph1tHKXxzAz8e8/nZaUoQMlg2z7ba09ah57Catlt6ouRaxa++BXbwKfRsmG8aYhSDy8bUEwa9VSi1glE65aY=

data/README.md

@@ -2,6 +2,7 @@
 
 A Ruby wrapper for the [PopIt](http://popit.mysociety.org/) API, which allows you to create, read, update and delete documents from PopIt.
 
+[![Gem Version](https://badge.fury.io/rb/popit.svg)](http://badge.fury.io/rb/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)
 [![Coverage Status](https://coveralls.io/repos/opennorth/popit-ruby/badge.png?branch=master)](https://coveralls.io/r/opennorth/popit-ruby)
@@ -31,8 +32,8 @@ You can pass these options to `PopIt.new`:
 * `: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 "v0.1"
-* `:user` a user name – if blank, the API will be read-only
-* `:password` the user's password
+* `:apikey` an API key – if blank, the API will be read-only
+* `:max_retries` the number of times to retry the API in case of errors - defaults to 0
 
 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`.
 
@@ -108,8 +109,7 @@ api.persons.get('foo') # raises PopIt::PageNotFound with "page not found"
 To run the tests:
 
     export INSTANCE_NAME=YOUR_POPIT_INSTANCE_NAME
-    export POPIT_USER=YOUR_POPIT_EMAIL_ADDRESS
-    export POPIT_PASSWORD=YOUR_POPIT_PASSWORD
+    export POPIT_API_KEY=YOUR_POPIT_API_KEY
     bundle exec rake
 
 **If you care about the data in an instance, do not use that instance to run tests!**

data/lib/popit.rb

@@ -35,10 +35,8 @@ class PopIt
   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
+  # An API key.
+  attr_reader :apikey
   # The maximum number of retries in case of HTTP 503 Service Unavailable errors.
   attr_reader :max_retries
 
@@ -49,8 +47,7 @@ class PopIt
   # @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] :version the PopIt API version, eg "v1"
-  # @option opts [String] :user a user name
-  # @option opts [String] :password the user's password
+  # @option opts [String] :apikey an API key
   # @option opts [String] :max_retries the maximum number of retries in case of
   #  HTTP 503 Service Unavailable errors
   def initialize(opts = {})
@@ -62,8 +59,7 @@ class PopIt
     @host_name     = opts[:host_name]   || 'popit.mysociety.org'
     @port          = opts[:port]        || 80
     @version       = opts[:version]     || 'v0.1'
-    @username      = opts[:user]
-    @password      = opts[:password]
+    @apikey        = opts[:apikey]
     @max_retries   = opts[:max_retries] || 0
 
   end
@@ -115,9 +111,9 @@ private
     when :get
       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, :query => opts.merge(:apikey => apikey))
     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, :body => JSON.dump(opts.merge(:apikey => apikey)), :headers => {'Content-Type' => 'application/json'})
     end
 
     unless ['200', '201', '204'].include?(response.response.code)

data/lib/popit/version.rb

@@ -1,3 +1,3 @@
 class PopIt
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/popit.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency('httparty', '~> 0.10.0')
-  s.add_development_dependency('rspec', '~> 2.10')
+  s.add_development_dependency('rspec', '~> 3.1.0')
   s.add_development_dependency('rake')
   s.add_development_dependency('coveralls')
 end

data/spec/popit_spec.rb

@@ -13,8 +13,7 @@ describe PopIt do
   let :authenticated do
     PopIt.new({
       :instance_name => ENV['INSTANCE_NAME'] || 'tttest',
-      :user          => ENV['POPIT_USER'] || 'james@opennorth.ca',
-      :password      => ENV['POPIT_PASSWORD'],
+      :apikey        => ENV['POPIT_API_KEY'],
     })
   end
 
@@ -48,12 +47,12 @@ describe PopIt do
     context 'when unauthenticated' do
       it 'should get all items' do
         response = unauthenticated.persons.get
-        response.should be_an(Array)
+        expect(response).to be_an(Array)
       end
 
       it 'should get one item by name' do
         response = unauthenticated.persons.get(:name => 'Foo')
-        response.should be_an(Array)
+        expect(response).to be_an(Array)
       end
 
       it 'should get one item' do
@@ -62,7 +61,7 @@ describe PopIt do
         # other_names, personal_details and adds positions_api_url to meta.
         person.each do |k,v|
           unless k == 'meta'
-            response[k].should == v
+            expect(response[k]).to eq(v)
           end
         end
       end
@@ -72,15 +71,15 @@ describe PopIt do
       end
 
       it 'should fail to create an item' do
-        expect {unauthenticated.persons.post(:name => 'John Doe', :slug => 'john-doe')}.to raise_error(PopIt::NotAuthenticated, 'not authenticated')
+        expect {unauthenticated.persons.post(:name => 'John Doe', :slug => 'john-doe')}.to raise_error(PopIt::NotAuthenticated, 'Unauthorized')
       end
 
       it 'should fail to update an item' do
-        expect {unauthenticated.persons(id).put(:id => id, :name => 'John Doe', :slug => 'john-doe')}.to raise_error(PopIt::NotAuthenticated, 'not authenticated')
+        expect {unauthenticated.persons(id).put(:id => id, :name => 'John Doe', :slug => 'john-doe')}.to raise_error(PopIt::NotAuthenticated, 'Unauthorized')
       end
 
       it 'should fail to delete an item' do
-        expect {unauthenticated.persons(id).delete}.to raise_error(PopIt::NotAuthenticated, 'not authenticated')
+        expect {unauthenticated.persons(id).delete}.to raise_error(PopIt::NotAuthenticated, 'Unauthorized')
       end
     end
 
@@ -89,10 +88,10 @@ describe PopIt do
         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'
+        expect(response['name']).to eq('John Smith')
 
         response = authenticated.persons(id).put(:id => id, :name => 'John Doe', :slug => 'john-doe')
-        response.should == {
+        expect(response).to eq({
           'id'              => id,
           'name'            => 'John Doe',
           'slug'            => 'john-doe',
@@ -107,20 +106,20 @@ describe PopIt do
           'other_names'     => [],
           'url'             => 'http://tttest.popit.mysociety.org/api/v0.1/persons/' + id,
           'html_url'        => 'http://tttest.popit.mysociety.org/persons/' + id,
-        }
-        authenticated.persons(id).get['name'].should == 'John Doe'
+        })
+        expect(authenticated.persons(id).get['name']).to eq('John Doe')
 
         response = authenticated.persons(id).delete
-        response.should == nil
+        expect(response).to be_nil
         expect {authenticated.persons(id).get}.to raise_error(PopIt::PageNotFound, "id '#{id}' not found")
       end
     end
 
     context 'when service unavailable' do
       before :each do
-        PopIt.stub(:get) do
+        allow(PopIt).to receive(:get) do
           response = Net::HTTPServiceUnavailable.new('1.1', 503, 'Service Unavailable')
-          response.stub(:body => '', :code => '503')
+          allow(response).to receive_messages(:body => '', :code => '503')
           HTTParty::Response.new(HTTParty::Request.new(Net::HTTP::Get, '/'), response, lambda {})
         end
       end
@@ -128,13 +127,13 @@ describe PopIt do
       it 'should fail immediately' do
         time = Time.now
         expect {unauthenticated.persons.get}.to raise_error(PopIt::ServiceUnavailable)
-        Time.now.should be_within(1).of(time)
+        expect(Time.now).to be_within(1).of(time)
       end
 
       it 'should backoff exponentially' do
         time = Time.now
         expect {exponential_backoff.persons.get}.to raise_error(PopIt::ServiceUnavailable)
-        Time.now.should_not be_within(5).of(time)
+        expect(Time.now).to_not be_within(5).of(time)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: popit
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Open North
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-09 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -113,3 +113,4 @@ summary: The PopIt API Ruby Gem
 test_files:
 - spec/popit_spec.rb
 - spec/spec_helper.rb
+has_rdoc: