infreemation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac0ba437d15456f90a07b1d593e7cd27b59b189a5fb341fc36a8f429c61478d6
+  data.tar.gz: 0beb6bb42829673ed8b7e174b20798d57d6552f3a79ccd0c38f5e9ae957d9332
+SHA512:
+  metadata.gz: 19cd8059ea1197f3772c200cb92bf6eff2f2109c3e1a9fd70af63195ab385effed9e83b6179fd1210735fe3e4f1d56f1c01698bd6c6b64f313a23b190de51346
+  data.tar.gz: 88dc1e807c9fd4604188510cc12ad53f3f8b181b6e47e627fc7605d33f72bc2a14406b34eecf04865dc51d173cd9003f01405a173e655203ee3daf2a0b110c4a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*_spec.rb'
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Style/MixinUsage:
+  Exclude:
+    - 'spec/spec_helper.rb'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.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 hello@mysociety.org. 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,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in infreemation.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    infreemation (0.1.0)
+      json (~> 2.1.0)
+      rest-client (~> 2.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.7)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.1.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    parallel (1.12.1)
+    parser (2.5.0.5)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    public_suffix (3.0.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.54.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    unicode-display_width (1.3.0)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  infreemation!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.54.0)
+  webmock (~> 3.3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 UK Citizens Online Democracy (UKCOD)
+
+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,75 @@
+# Infreemation
+
+A Ruby client library for the [Infreemation](http://www.digital-interactive.com/products/infreemation) API from [Digital Interactive](http://www.digital-interactive.com). Infreemation is a eCase management software system built specifically to manage FOI, EIR and SAR requests. Currently this library only supports FOI requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'infreemation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install infreemation
+
+## Configuration
+
+If you're using Rails, add the following to `config/initializers/infreemation.rb`:
+
+``` ruby
+Infreemation.logger = Rails.logger
+Infreemation.url = ENV['INFREEMATION_URL']
+Infreemation.api_key = ENV['INFREEMATION_API_KEY']
+Infreemation.username = ENV['INFREEMATION_USERNAME']
+```
+
+## Usage
+
+### Creating requests
+
+```ruby
+Infreemation::Request.create!(
+  rt: 'create',
+  type: 'FOI',
+  requester: 'Fred Smith',
+  contact: 'fred@example.com',
+  contacttype: 'email',
+  subject: 'Missed Bins',
+  category: 'Waste',
+  body: 'Dear FOI team/nPlease treat this as a request under the FOI act etc'
+)
+```
+
+### Retrieving published requests
+
+```ruby
+Infreemation::Request.where(
+  rt: 'published',
+  startdate: '2018-01-01',
+  enddate: '2019-01-01'
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mysociety/infreemation-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Infreemation project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mysociety/infreemation-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'infreemation'
+
+# 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(__FILE__)

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/infreemation.gemspec

@@ -0,0 +1,45 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'infreemation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'infreemation'
+  spec.version       = Infreemation::VERSION
+  spec.authors       = ['mySociety']
+  spec.email         = ['hello@mysociety.org']
+
+  spec.summary       = 'Ruby library for the Infreemation API.'
+  spec.description   = 'Infreemation is a eCase management software system ' \
+    'built specifically to manage FOI, EIR and SAR requests.'
+  spec.homepage      = 'https://github.com/mysociety/infreemation'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # "allowed_push_host" to allow pushing to a single host or delete this section
+  # to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  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 'json', '~> 2.1.0'
+  spec.add_dependency 'rest-client', '~> 2.0.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.54.0'
+  spec.add_development_dependency 'webmock', '~> 3.3.0'
+end

data/lib/infreemation.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'infreemation/version'
+
+##
+# This module is the main entry point of the Gem
+#
+module Infreemation
+  require 'infreemation/api'
+  require 'infreemation/errors'
+  require 'infreemation/request'
+
+  ConfigurationError = Class.new(StandardError)
+
+  class << self
+    attr_accessor :logger
+    attr_writer :url, :api_key, :username
+
+    def url
+      @url || raise(
+        ConfigurationError, 'Infreemation.url not configured'
+      )
+    end
+
+    def api_key
+      @api_key || raise(
+        ConfigurationError, 'Infreemation.api_key not configured'
+      )
+    end
+
+    def username
+      @username || raise(
+        ConfigurationError, 'Infreemation.username not configured'
+      )
+    end
+
+    def log(level, message)
+      logger&.send(level, name) { message }
+    end
+  end
+end

data/lib/infreemation/api.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'rest_client'
+
+module Infreemation
+  ##
+  # This class is responsible for communicating with the remote API server
+  #
+  class API
+    class << self
+      # The #get method is doing a POST request. This is because the
+      # Infreemation API is expecting raw POST data and the Ruby net/http core
+      # library understandably does not support this.
+      def get(path, params)
+        Infreemation.log :debug, "GET #{path} with #{params.inspect}"
+        resource[path].post(with_auth(params), &parser)
+      rescue RestClient::Exception => e
+        raise RequestError, e.message
+      end
+
+      def post(path, body)
+        Infreemation.log :debug, "POST #{path} with #{body.inspect}"
+        resource[path].post(with_auth(body), &parser)
+      rescue RestClient::Exception => e
+        raise RequestError, e.message
+      end
+
+      private
+
+      def with_auth(options)
+        options.merge(
+          key: Infreemation.api_key,
+          username: Infreemation.username
+        ).to_json
+      end
+
+      def resource
+        RestClient::Resource.new(Infreemation.url)
+      end
+
+      def parser
+        lambda do |response, _request, _result|
+          Infreemation.log :debug, response.body
+          begin
+            JSON.parse(response.body, symbolize_names: true).tap do |data|
+              raise Errors[data[:ref]], data[:error] if data[:status] == 'ERROR'
+            end
+          rescue JSON::ParserError
+            raise ResponseError, 'JSON invalid'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/infreemation/errors.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Infreemation
+  ##
+  # A base error
+  #
+  Exception = Class.new(StandardError)
+
+  ##
+  # A generic error
+  #
+  GenericError = Class.new(Exception)
+
+  ##
+  # An API authenication error
+  #
+  AuthenticationError = Class.new(Exception)
+
+  ##
+  # A request error
+  #
+  RequestError = Class.new(Exception)
+
+  ##
+  # A response error
+  #
+  ResponseError = Class.new(Exception)
+
+  ##
+  # A missing parameter error
+  #
+  MissingParameterError = Class.new(Exception)
+
+  ERROR_MAPPINGS = {
+    2 => AuthenticationError,
+    3 => RequestError,
+    5 => MissingParameterError, # requester
+    6 => MissingParameterError, # contact
+    7 => MissingParameterError, # contacttype
+    8 => MissingParameterError  # body
+  }.freeze
+
+  ##
+  # This module is resposible for mapping error codes into the correct type to
+  # exception class
+  #
+  module Errors
+    def self.[](code)
+      ERROR_MAPPINGS[code.to_i] || GenericError
+    end
+  end
+end

data/lib/infreemation/request.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Infreemation
+  ##
+  # This class represents a FOI or EIR request
+  #
+  class Request
+    class << self
+      def path
+        '/foi/'
+      end
+
+      def create!(attributes = {})
+        new(attributes, &:save!)
+      end
+
+      def where(options = {})
+        type = options.fetch(:rt).downcase.to_sym
+        requests_data = API.get(path, options).dig(type, :request) || []
+        requests_data.map { |attributes| new(attributes) }
+      end
+    end
+
+    attr_reader :attributes
+
+    def initialize(attributes = {})
+      @attributes = attributes
+      yield self if block_given?
+    end
+
+    def save!
+      @attributes.merge!(API.post(self.class.path, attributes))
+      true
+    end
+  end
+end

data/lib/infreemation/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Infreemation
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: infreemation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mySociety
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: Infreemation is a eCase management software system built specifically
+  to manage FOI, EIR and SAR requests.
+email:
+- hello@mysociety.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- infreemation.gemspec
+- lib/infreemation.rb
+- lib/infreemation/api.rb
+- lib/infreemation/errors.rb
+- lib/infreemation/request.rb
+- lib/infreemation/version.rb
+homepage: https://github.com/mysociety/infreemation
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Ruby library for the Infreemation API.
+test_files: []