laa-apply-for-legalaid-api-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ceb54d14bf632f9cd3d51480833d44d6509159a1911c7f51dca8d8c2277ac2b
+  data.tar.gz: 9201c22e180ab08ae0d66f5382c8482c5808ab0a075485a83d63a42427039caf
+SHA512:
+  metadata.gz: 5e95484d7bc46b4744d22281dfe3caa2c116029a65c4fd3398ead10ded5e798a243197655b6e2c77caca55cb9beb9a5fe804eff5dd21b77da0becdb658da871b
+  data.tar.gz: 96f71e5148e6bf5e68ef2f57ec947cf3feebefeaa092d0b098cd4e8fda6a1af87f5b3bbb508bf6c75bb472277523891e3989e1dc6b7c025c5f64ab1f6d99d992

data/.circleci/config.yml

@@ -0,0 +1,24 @@
+version: 2.0
+
+references:
+  test_container_config: &test_container_config
+    docker:
+      - image: circleci/ruby:2.5.1
+
+jobs:
+  test:
+    <<: *test_container_config
+    steps:
+    - checkout
+    - run:
+        name: Install gems
+        command: bundle install
+    - run:
+        name: Run Tests
+        command: bundle exec rake
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+      - test

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Rspec status report
+.rspec_status

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in laa-apply-for-legalaid-api-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    laa-apply-for-legalaid-api-client (0.1.0)
+      faraday (~> 0.15.2)
+      faraday_middleware (~> 0.12.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    hashdiff (0.3.7)
+    json_matchers (0.10.0)
+      json_schema
+    json_schema (0.19.1)
+    method_source (0.9.0)
+    multipart-post (2.0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    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)
+    safe_yaml (1.0.4)
+    vcr (4.0.0)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  json_matchers (~> 0.10.0)
+  laa-apply-for-legalaid-api-client!
+  pry-byebug (~> 3.6.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr (~> 4.0.0)
+  webmock (~> 3.4.2)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Ministry of Justice
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sergio Marques
+
+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,92 @@
+# Laa::ApplyForLegalAid::Api
+
+This is an HTTP client gem to perform calls to the LAA Apply for legal aid API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'laa-apply-for-legalaid-api-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install laa-apply-for-legalaid-api-client
+
+## Usage
+
+* Configure the client:
+
+```ruby
+# In a Rails application, this configuration is normally
+# setup in an initializer
+Laa::ApplyForLegalAid::Api.configure do |c|
+  c.host = 'http://your-api-host-name'
+end
+```
+
+* Get an instance of the client:
+
+```ruby
+# This instance will use configurations setup in the previous step
+api_client = Laa::ApplyForLegalAid::Api.client
+```
+
+* Performing requests
+
+```ruby
+# e.g:
+api_client.create_application(application_params)
+api_client.get_application(application_ref)
+```
+
+## Development
+
+### Setup
+
+After checking out the repo, run:
+
+```
+bin/setup
+```
+
+to install dependencies.
+
+### Running tests
+
+```
+rake spec
+```
+
+### Interactive prompt
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment
+
+### Release process
+
+To install this gem onto your local machine:
+
+```
+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/ministryofjustice/laa-apply-for-legalaid-api-ruby-client/issues.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "laa/apply_for_legal_aid/api"
+
+# 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/laa-apply-for-legalaid-api-client.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'laa/apply_for_legal_aid/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'laa-apply-for-legalaid-api-client'
+  spec.version       = Laa::ApplyForLegalAid::Api::VERSION
+  spec.authors       = ['Sergio Marques', 'Ministry of Justice']
+  spec.email         = ['sergio.marques@digital.justice.gov.uk', 'tools@digital.justice.gov.uk']
+
+  spec.summary       = %q{Ruby client for the LAA Apply for legal aid API}
+  spec.homepage      = 'https://github.com/ministryofjustice/laa-apply-for-legalaid-api-ruby-client'
+  spec.license       = 'MIT'
+
+  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 'faraday', '~> 0.15.2'
+  spec.add_dependency 'faraday_middleware', '~> 0.12.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'json_matchers', '~> 0.10.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.6.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 4.0.0'
+  spec.add_development_dependency 'webmock', '~> 3.4.2'
+end

data/lib/laa-apply-for-legalaid-api-client.rb

@@ -0,0 +1 @@
+require 'laa/apply_for_legal_aid/api'

data/lib/laa/apply_for_legal_aid/api.rb

@@ -0,0 +1,26 @@
+require 'laa/apply_for_legal_aid/api/version'
+require 'laa/apply_for_legal_aid/api/core_ext/array'
+require 'laa/apply_for_legal_aid/api/configuration'
+require 'laa/apply_for_legal_aid/api/client'
+
+module Laa
+  module ApplyForLegalAid
+    module Api
+      extend self
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+      alias config configuration
+
+      def configure
+        yield(configuration) if block_given?
+        configuration
+      end
+
+      def client
+        Client.new(configuration.host)
+      end
+    end
+  end
+end

data/lib/laa/apply_for_legal_aid/api/client.rb

@@ -0,0 +1,42 @@
+require 'faraday'
+require 'faraday_middleware'
+require_relative 'request'
+require_relative 'requests'
+
+module Laa
+  module ApplyForLegalAid
+    module Api
+      class Client
+        attr_reader :host
+
+        include Requests
+
+        def initialize(host, options = {})
+          @host = host
+          @options = options
+        end
+
+        def method_missing(method_name, *args, &block)
+          return super unless Request::HTTP_METHODS.include?(method_name)
+          path = args.shift
+          req_options = args.extract_options!
+          Request.new(method_name, path, connection).call(req_options)
+        end
+
+        private
+
+        def connection
+          @connection ||= initialize_connection
+        end
+
+        def initialize_connection
+          Faraday.new(url: host) do |conn|
+            conn.request :json
+            conn.response :json, content_type: /\bjson$/
+            conn.adapter Faraday.default_adapter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/laa/apply_for_legal_aid/api/configuration.rb

@@ -0,0 +1,13 @@
+module Laa
+  module ApplyForLegalAid
+    module Api
+      class Configuration
+        attr_accessor :host
+
+        def initialize(options = {})
+          @host = options[:host]
+        end
+      end
+    end
+  end
+end

data/lib/laa/apply_for_legal_aid/api/core_ext/array.rb

@@ -0,0 +1,5 @@
+class Array
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end unless method_defined? :extract_options!
+end

data/lib/laa/apply_for_legal_aid/api/request.rb

@@ -0,0 +1,45 @@
+module Laa
+  module ApplyForLegalAid
+    module Api
+      class Request
+        HTTP_METHODS = [:get, :head, :post, :put, :delete, :patch].freeze
+        HTTP_METHODS_WITH_BODY = [:post, :put, :patch].freeze
+
+        attr_reader :action, :path
+
+        def initialize(action, path, connection)
+          @action = action
+          @path = path
+          @connection = connection
+          validate_http_method
+        end
+
+        def call(options = {})
+          # TODO: wrap the response in a response object we own
+          connection.send(action) do |request|
+            request.url(path, options[:query] || {})
+            request.body = request_body(options[:data]) if body_required? && options.has_key?(:data)
+          end
+        end
+
+        private
+
+        attr_reader :connection
+
+        def validate_http_method
+          return if HTTP_METHODS.include?(action)
+          raise ArgumentError, "invalid HTTP method #{action}"
+        end
+
+        def body_required?
+          HTTP_METHODS_WITH_BODY.include?(action)
+        end
+
+        def request_body(data)
+          return data if data.is_a?(String)
+          data.to_json
+        end
+      end
+    end
+  end
+end

data/lib/laa/apply_for_legal_aid/api/requests.rb

@@ -0,0 +1,13 @@
+require 'laa/apply_for_legal_aid/api/requests/applications'
+
+module Laa
+  module ApplyForLegalAid
+    module Api
+      module Requests
+        def self.included(base)
+          base.include(Applications)
+        end
+      end
+    end
+  end
+end

data/lib/laa/apply_for_legal_aid/api/requests/applications.rb

@@ -0,0 +1,21 @@
+module Laa
+  module ApplyForLegalAid
+    module Api
+      module Requests
+        module Applications
+          def create_application(params)
+            post("/v1/applications", params)
+          end
+
+          def update_application(params)
+            patch("/v1/applications", params)
+          end
+
+          def get_application(application_id)
+            get("/v1/applications/#{application_id}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/laa/apply_for_legal_aid/api/version.rb

@@ -0,0 +1,7 @@
+module Laa
+  module ApplyForLegalAid
+    module Api
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: laa-apply-for-legalaid-api-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergio Marques
+- Ministry of Justice
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.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: json_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+description: 
+email:
+- sergio.marques@digital.justice.gov.uk
+- tools@digital.justice.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- laa-apply-for-legalaid-api-client.gemspec
+- lib/laa-apply-for-legalaid-api-client.rb
+- lib/laa/apply_for_legal_aid/api.rb
+- lib/laa/apply_for_legal_aid/api/client.rb
+- lib/laa/apply_for_legal_aid/api/configuration.rb
+- lib/laa/apply_for_legal_aid/api/core_ext/array.rb
+- lib/laa/apply_for_legal_aid/api/request.rb
+- lib/laa/apply_for_legal_aid/api/requests.rb
+- lib/laa/apply_for_legal_aid/api/requests/applications.rb
+- lib/laa/apply_for_legal_aid/api/version.rb
+homepage: https://github.com/ministryofjustice/laa-apply-for-legalaid-api-ruby-client
+licenses:
+- MIT
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Ruby client for the LAA Apply for legal aid API
+test_files: []