parliament-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 723becb108a322e281da7b1caf864791ed4707ba
+  data.tar.gz: 26f7be8681949436953d83d45e4fddffb5044149
+SHA512:
+  metadata.gz: bdcb1face1f18f79a9acf84c73673bde3aa7df4c1fa1fd279e253d2c891770fc97ddab9c75b4aa9c3c29c2cf92b35886bbfb196077be238cd527f2f06de3dda1
+  data.tar.gz: 2d86fbfdd19c45e0289900aa4381c89d983c11635ecf07ef0dba31640c6493dd4a3bb5b00b1cfd5812945975dd35cf2a3d67a1fb79541d2250474d1c6379d924

data/.bash_profile

@@ -0,0 +1 @@
+alias be='bundle exec'

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+.idea

data/.hound.yml

@@ -0,0 +1,4 @@
+ruby:
+  config_file: .rubocop.yml
+
+fail_on_violations: true

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,57 @@
+Metrics/LineLength:
+  Description: 'Limit lines to 120 characters.'
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/SpaceBeforeFirstArg:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/AlignHash:
+  Severity: fatal
+  Enabled: true
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+Style/DotPosition:
+  EnforcedStyle: leading
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/SpaceAroundOperators:
+  # When true, allows most uses of extra spacing if the intent is to align
+  # with an operator on the previous or next line, not counting empty lines
+  # or comment lines.
+  AllowForAlignment: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,4 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mattrayner1@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in parliament-ruby.gemspec
+gemspec
+
+# Include coveralls for CI coverage reports
+gem 'coveralls', require: false

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2016-2017 United Kingdom Parliament
+
+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,138 @@
+# Parliament Data API Wrapper (Ruby)
+[parliament-ruby][parliament-ruby] is a gem created by the [Parliamentary Digital Service][pds] to allow easy communication with the internal parliament data api.
+
+[![Build Status][shield-travis]][info-travis] [![Test Coverage][shield-coveralls]][info-coveralls] [![License][shield-license]][info-license]
+
+> **NOTE:** This gem is in active development and is likely to change at short notice. It is not recommended that you use this in any production environment.
+
+### Contents
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Setting up a connection](#setting-up-a-connection)
+    - [Setting a base URL 'globally'](#setting-a-base-url-globally)
+  - [Building an 'endpoint'](#building-an-endpoint)
+    - [What's #get?](#whats-get)
+- [Getting Started with Development](#getting-started-with-development)
+  - [Running the tests](#running-the-tests)
+- [Contributing](#contributing)
+- [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+
+## Requirements
+[parliament-ruby][parliament-ruby] requires the following:
+* [Ruby][ruby] - [click here][ruby-version] for the exact version
+* [Bundler][bundler]
+
+
+## Installation
+This gem is currently not available on RubyGems. To use it in an application, install it directly from GitHub via your Gemfile
+```bash
+gem 'parliament', git: 'https://github.com/ukparliament/parliament-ruby.git', branch: 'master'
+```
+
+
+## Usage
+This gem's main function is fetching an n-triple file from a remote server and converting it into linked ruby objects.
+
+### Setting up a connection
+In order to connect to a remote server, we first need to set a base_url value, from which we will build an 'endpoint'. The base_url should be the beginning of a url without the trailing slash. For example `http://example.com` instead of `http://example.com/`.
+```ruby
+parliament = Parliament::Request.new(base_url: 'http://test.com')
+```
+
+#### Setting a base URL 'globally'
+Within code you can set a global base URL using the following snippet.
+```ruby
+Parliament::Request.base_url = 'http://test.com'
+
+# The base_url should be set for all new objects
+Parliament::Request.new.base_url #=> 'http://test.com'
+
+# You can still override the base_url on an instance by instance basis
+Parliament::Request.new(base_url: 'http://example.com').base_url #=> 'http://example.com'
+```
+
+Alternatively, you can set the environment variable `PARLIAMENT_BASE_URL` on your machine and we will automatically use that.
+```ruby
+ENV['PARLIAMENT_BASE_URL'] #=> 'http://example.com'
+
+Parliament::Request.base_url #=> nil
+
+Parliament::Request.new.base_url #=> 'http://example.com'
+```
+
+
+### Building an 'endpoint'
+Now that we have a `base_url` set, we will want to build an 'endpoint' such as: `http://test.com/parties/current.nt`.
+
+An endpoint is effectively just a full URL to an n-triple file on a remote server.
+
+Building an endpoint is simple, once you have a Parliament::Request object, you do something like this:
+```ruby
+parliament = Parliament::Request.new(base_url: 'http://test.com') #=>  #<Parliament::Request>
+
+# target endpoint: 'http://test.com/parties/current.nt'
+parliament.parties.current.get
+
+# target endpoint: 'http://test.com/parties/123/people/current.nt'
+parliament.parties('123').people.current.get
+
+# target endpoint: 'http://test.com/people/123/letters/456.nt'
+parliament.people('123').letters('456').get
+```
+
+#### What's #get?
+Once you've built your endpoint (`parliament.people.current`), we use the `#get` method to tell us you're finished building and ready to get the data. 
+
+
+## Getting Started with Development
+To clone the repository and set up the dependencies, run the following:
+```bash
+git clone https://github.com/ukparliament/parliament-ruby.git
+cd parliament-ruby
+bundle install
+```
+
+### Running the tests
+We use [RSpec][rspec] as our testing framework and tests can be run using:
+```bash
+bundle exec rake
+```
+
+
+## Contributing
+If you wish to submit a bug fix or feature, you can create a pull request and it will be merged pending a code review.
+
+1. Fork the repository
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Ensure your changes are tested using [Rspec][rspec]
+1. Create a new Pull Request
+
+
+## License
+[parliament-ruby][parliament-ruby] is licensed under the [Open Parliament Licence][info-license].
+
+[ruby]:            https://www.ruby-lang.org/en/
+[bundler]:         http://bundler.io
+[rspec]:           http://rspec.info
+[parliament-ruby]: https://github.com/ukparliament/parliament-ruby
+[pds]:             https://www.parliament.uk/mps-lords-and-offices/offices/bicameral/parliamentary-digital-service/
+[ruby-version]:    https://github.com/ukparliament/parliament-ruby/blob/master/.ruby-version
+
+[info-travis]:   https://travis-ci.org/ukparliament/parliament-ruby
+[shield-travis]: https://img.shields.io/travis/ukparliament/parliament-ruby.svg
+
+[info-coveralls]:   https://coveralls.io/github/ukparliament/parliament-ruby
+[shield-coveralls]: https://img.shields.io/coveralls/ukparliament/parliament-ruby.svg
+
+[info-license]:   http://www.parliament.uk/site-information/copyright/open-parliament-licence/
+[shield-license]: https://img.shields.io/badge/license-Open%20Parliament%20Licence-blue.svg

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'parliament'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/parliament.rb

@@ -0,0 +1,11 @@
+require 'pry'
+require 'net/http'
+require 'grom'
+
+require 'parliament/version'
+require 'parliament/request'
+require 'parliament/response'
+
+module Parliament
+  # Your code goes here...
+end

data/lib/parliament/request.rb

@@ -0,0 +1,43 @@
+module Parliament
+  class Request
+    attr_reader :base_url
+
+    def initialize(base_url: nil)
+      @endpoint_parts = []
+      @base_url = base_url || self.class.base_url || ENV['PARLIAMENT_BASE_URL']
+    end
+
+    def method_missing(method, *params, &block)
+      # TODO: Fix this smell
+      super if method == :base_url=
+
+      @endpoint_parts << method.to_s
+      @endpoint_parts << params
+      @endpoint_parts = @endpoint_parts.flatten!
+      self
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      (method != :base_url=) || super
+    end
+
+    def get
+      response = Net::HTTP.get_response(URI(api_endpoint))
+
+      raise StandardError, 'This is a HTTPClientError' if response.is_a?(Net::HTTPClientError)
+      raise StandardError, 'This is a HTTPServerError' if response.is_a?(Net::HTTPServerError)
+
+      Parliament::Response.new(Grom::Reader.new(response.body).objects)
+    end
+
+    private
+
+    class << self
+      attr_accessor :base_url
+    end
+
+    def api_endpoint
+      [@base_url, @endpoint_parts].join('/') + '.nt'
+    end
+  end
+end

data/lib/parliament/response.rb

@@ -0,0 +1,29 @@
+require 'forwardable'
+
+module Parliament
+  class Response
+    include Enumerable
+    extend Forwardable
+    attr_reader :nodes
+    def_delegators :@nodes, :size, :each, :select, :map, :select!, :map!, :count, :length
+
+    def initialize(nodes)
+      @nodes = nodes
+    end
+
+    def filter(*types)
+      filtered_objects = Array.new(types.size) { [] }
+
+      unless types.empty?
+        @nodes.each do |node|
+          type_index = types.index(node.type)
+          filtered_objects[type_index] << node unless type_index.nil?
+        end
+      end
+
+      filtered_objects.each do |objects|
+        Parliament::Response.new(objects)
+      end
+    end
+  end
+end

data/lib/parliament/version.rb

@@ -0,0 +1,3 @@
+module Parliament
+  VERSION = '0.1.0'.freeze
+end

data/parliament-ruby.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'parliament/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'parliament-ruby'
+  spec.version       = Parliament::VERSION
+  spec.authors       = ['Matt Rayner']
+  spec.email         = ['mattrayner1@gmail.com']
+  spec.summary       = %q{Internal parliamentary data API wrapper for ruby}
+  spec.description   = %q{Internal parliamentary data API wrapper for ruby}
+  spec.homepage      = 'http://github.com/ukparliament/parliament_ruby'
+  spec.license       = 'Open Parliament License'
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'grom', '~> 0.2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.47.1'
+  spec.add_development_dependency 'pry', '~> 0.10.4'
+  spec.add_development_dependency 'pry-nav', '~> 0.2.4'
+  spec.add_development_dependency 'simplecov', '~> 0.12.0'
+  spec.add_development_dependency 'vcr', '~> 3.0.3'
+  spec.add_development_dependency 'webmock', '~> 2.3.2'
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: parliament-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Rayner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+description: Internal parliamentary data API wrapper for ruby
+email:
+- mattrayner1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bash_profile"
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/parliament.rb
+- lib/parliament/request.rb
+- lib/parliament/response.rb
+- lib/parliament/version.rb
+- parliament-ruby.gemspec
+homepage: http://github.com/ukparliament/parliament_ruby
+licenses:
+- Open Parliament License
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Internal parliamentary data API wrapper for ruby
+test_files: []