popit 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+.yardoc
+Gemfile.lock
+doc/*
+pkg/*
+spec/spec_auth.yml

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Open North Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# 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.
+
+[![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)
+
+## Installation
+
+    gem install popit
+
+## API Examples
+
+Require the PopIt gem:
+
+```ruby
+require 'popit'
+```
+
+Create an API client:
+
+```ruby
+api = PopIt.new :instance_name => 'demo'
+```
+
+You can pass the options:
+
+* `: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"
+* `:user` a user name – if blank, the API will be read-only
+* `:password` the user's password
+
+For brevity, we only show examples for `person` items, but you use the same code to operate on organisations and positions by substituting `organisation` or `position` for `person`.
+
+More documentation at [RubyDoc.info](http://rdoc.info/gems/popit/PopIt).
+
+### Read
+
+Get all people:
+
+```ruby
+response = api.person.get
+p response['results']
+```
+
+Get one person:
+
+```ruby
+response = api.person('47cc67093475061e3d95369d').get
+p response['result']
+```
+
+You can search...
+
+* people by slug, name or summary
+* organisations by slug or name
+* positions by title, person or organisation
+
+```ruby
+response = api.person.get :name => 'John Doe'
+p response['results']
+```
+
+### Create
+
+```ruby
+response = api.person.post :name => 'John Doe'
+id = response['result']['_id']
+```
+
+### Update
+
+```ruby
+response = api.person('47cc67093475061e3d95369d').put :name => 'Jane Doe'
+p response['result']
+```
+
+### Delete
+
+```ruby
+success = api.person('47cc67093475061e3d95369d').delete
+```
+
+## Error Handling
+
+If you:
+
+* attempt to read an item that doesn't exist
+* attempt to create, update or delete an item without authenticating
+* attempt to operate on something other than people, organisations and positions
+
+you will raise a `PopIt::Error` exception. The exception's message will be the error message from the PopIt API.
+
+```ruby
+require 'popit'
+api = PopIt.new :instance_name => 'demo'
+api.person.get 'foo' # raises PopIt::Error
+```
+
+## Running Tests
+
+To run the tests, create a `spec_auth.yml` file in the `spec` directory with the contents:
+
+```yml
+instance_name: YOUR_TEST_INSTANCE
+user: YOUR_USERNAME
+password: YOUR_PASSWORD
+```
+
+**If you care about the data in an instance, do not use that instance to run tests!**
+
+## Bugs? Questions?
+
+This gem's main repository is on GitHub: [http://github.com/opennorth/popit-ruby](http://github.com/opennorth/popit-ruby), where your contributions, forks, bug reports, feature requests, and feedback are greatly welcomed.
+
+Copyright (c) 2011 Open North Inc., released under the MIT license

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

data/USAGE

@@ -0,0 +1 @@
+See README.md for full usage details.

data/lib/popit/version.rb

@@ -0,0 +1,3 @@
+class PopIt
+  VERSION = "0.0.1"
+end

data/lib/popit.rb

@@ -0,0 +1,115 @@
+require 'httparty'
+require 'yajl'
+
+# A Ruby wrapper for the PopIt API.
+#
+# @see https://github.com/mysociety/popit/blob/master/lib/apps/api/api_v1.js
+class PopIt
+  class Error < StandardError; end
+
+  include HTTParty
+
+  attr_reader :instance_name, :host_name, :port, :version, :username, :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] :version the PopIt API version, eg "v1"
+  # @option opts [String] :user a user name
+  # @option opts [String] :password the user's password
+  def initialize(opts = {})
+    unless opts.has_key? :instance_name
+      raise ArgumentError, 'Missing key :instance_name'
+    end
+
+    @instance_name = opts[:instance_name]
+    @host_name     = opts[:host_name] || 'popit.mysociety.org'
+    @port          = opts[:port]
+    @version       = opts[:version]   || 'v1'
+    @username      = opts[:user]
+    @password      = opts[:password]
+  end
+
+  def base_uri
+    "http://#{instance_name}.#{host_name}:#{port}/api/#{version}"
+  end
+
+  def get(path, opts = {})
+    request :get, path, opts
+  end
+
+  def post(path, opts = {})
+    request :post, path, opts
+  end
+
+  def put(path, opts = {})
+    request :put, path, opts
+  end
+
+  def delete(path, opts = {})
+    request :delete, path, opts
+  end
+
+private
+
+  def request(http_method, path, opts = {})
+    path = "#{base_uri}/#{path}"
+
+    response = case http_method
+    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
+    when :post, :put
+      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
+      else
+        response.response.body
+      end
+      raise PopIt::Error, message
+    end
+
+    response.parsed_response
+  end
+
+  def method_missing(*args)
+    Chain.new(self, args)
+  end
+
+  class Chain
+    attr_reader :klass, :chain
+
+    def initialize(klass, chain)
+      @klass = klass
+      @chain = chain
+    end
+
+    def get(opts = {})
+      @klass.get chain.join('/'), opts
+    end
+
+    def post(opts = {})
+      @klass.post chain.join('/'), opts
+    end
+
+    def put(opts = {})
+      @klass.put chain.join('/'), opts
+    end
+
+    def delete(opts = {})
+      @klass.delete chain.join('/'), opts
+    end
+
+    def method_missing(*args)
+      @chain += args
+      self
+    end
+  end
+end

data/popit.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "popit/version"
+
+Gem::Specification.new do |s|
+  s.name        = "popit"
+  s.version     = PopIt::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Open North"]
+  s.email       = ["info@opennorth.ca"]
+  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.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_development_dependency('rspec', '~> 2.10')
+  s.add_development_dependency('rake')
+end

data/spec/popit_spec.rb

@@ -0,0 +1,99 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'yaml'
+
+# We don't want to test the PopIt API. We want to check that the wrapper works.
+#
+# @see https://github.com/mysociety/popit-python/blob/master/test.py
+describe PopIt do
+  let :unauthenticated do
+    PopIt.new :instance_name => 'tttest'
+  end
+
+  let :authenticated do
+    PopIt.new YAML.load_file(File.expand_path(File.dirname(__FILE__) + '/spec_auth.yml'))
+  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')
+  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"}')
+  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
+    end
+
+    let :id do
+      @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"}')
+    end
+
+    context 'when unauthenticated' do
+      it 'should get all items' do
+        response = unauthenticated.person.get
+        results = response['results']
+        results.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)
+      end
+
+      it 'should get one item' do
+        response = unauthenticated.person(id).get
+        result = response['result']
+        result.should == person
+      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"}')
+      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"}))
+      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"}))
+      end
+
+      it 'should fail to delete an item' do
+        expect {unauthenticated.person(id).delete}.to raise_error(PopIt::Error, %({"error":"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'
+        response.should == nil
+      end
+
+      it 'should delete an item' do
+        response = authenticated.person(id).delete
+        response.should == {}
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'rspec'
+require File.dirname(__FILE__) + '/../lib/popit'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: popit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Open North
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+email:
+- info@opennorth.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- USAGE
+- lib/popit.rb
+- lib/popit/version.rb
+- popit.gemspec
+- spec/popit_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/opennorth/popit-ruby
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: The PopIt API Ruby Gem
+test_files:
+- spec/popit_spec.rb
+- spec/spec_helper.rb
+has_rdoc: