telephone_appointments 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a68c22ea72cc7042cdf4271298005e93f855402a
+  data.tar.gz: f48e156d0ef6ef3caac93fe09c890e5867f13cc0
+SHA512:
+  metadata.gz: 19b546c5dd67b311a0e5fd1a70401c0588892bdef7ea68a290c10a0068db4f7bcbbda64dae2d049b184bc3e63c7ee2bc23aa07fd6f4bd6ea9a9a648d49b32883
+  data.tar.gz: 22f3719cb582b67139ddf9dc11f2ffff3094c02e8a9dd180ddfe873c3a6fdae946cf3bdd1b9bc542832efb195005423526b952ff598a45db82475c431a96cb30

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  Exclude:
+    - 'bin/*'
+    - 'db/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.3
+
+Documentation:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Exclude:
+    - Rakefile
+
+Metrics/LineLength:
+  Max: 120
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/features/*'
+    - 'spec/requests/*'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'spec/features/*'
+    - 'spec/requests/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+- 2.3.3
+before_install: gem install bundler -v 1.12.5
+notifications:
+  slack:
+    secure: XecHmig/8T6A8kHE99V7GnXJJ6pDDH7QgjiI1gIcKXVOxsQEYDhfOgl0jZe+dn1t0rGR7JTClunI1vQCJPF/8W1iMLZHSS1oj0ow7W8Tdfo6UCKOscAsEp+5X1wxbvVEXuKwlkBQ7IcJeOeMglof6eUpOUCKm9j+NpvApXP8YYqIfBPKiMj1VQ7S/Bkckwe3DFomZxcIRKHM/TGe7A29ZauoWhXpYpy68BHMjDevmSPFXk5USigJXnBqdU/oH+uLUgBmEyc4396Yh5oQslPXxeXxavyvsIOFYIEmpjDez6JcQ7XgJy29lyZDQKYywP5yxisaXbeEpWjjqh5saaktukgRi8jLyTD2n6Zxq1udHg3TfWj+LccvF/NMu9cZGH4pvLB5jcGX5ZYlDAOddCujTsQu3mze/yb2XYSUp19bLBlA8TcnIPelAdzQS9vUGEcFfKIUvq1DQVYhsxfQ4rwyxBzbr8m4+FRum4HSDcb3HVSCCv/pusLISJS4kl+nLtk30hklRYZ/cz1CYj2WnhlsqYQOlrD/uZax0dthk+3v4cYW6tw2A3NNrEhUOUsTxH/+dPAstqmHrEKeSYJ3NTxw2Gfns2b0WB/alTFOe4S0c8/5h41G2d25wZTrUKcWyZYgdLMc9FY9CA2gvxTGKXde3UipEKwRs4GmsQ41RZsGXwg=

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in telephone_appointments.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ben Lovell
+
+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,69 @@
+# TelephoneAppointments
+
+Provides Telephone Appointment Planner API access.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'telephone_appointments'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install telephone_appointments
+
+## Usage
+
+```ruby
+
+summary_document = TelephoneAppointments::SummaryDocumentActivity.new(
+  appointment_id: id,
+  owner_uid: uid, 
+  delivery_method: message # 'postal' or 'digital'
+)
+summary_document.save # returns true or false
+
+summary_document.errors # returns a hash of errors if save is unsuccessful
+
+```
+
+The library provides a stubbed adapter:
+
+```ruby
+
+require 'telephone_appointments/stub_api'
+TelephoneAppointments.api = TelephoneAppointments::StubApi.new
+
+```
+
+This returns canned responses when creating a summary document.
+
+## 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/guidance-guarantee-programme/telephone_appointments.
+
+
+## License
+
+The gem is available as open source under the terms of the 
+[MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+default_tasks = [:spec]
+
+begin
+  # Rubocop is not available in envs other than development and test.
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+  default_tasks << :rubocop
+rescue LoadError
+end
+
+task default: default_tasks

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "telephone_appointments"
+
+# 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/telephone_appointments/api.rb

@@ -0,0 +1,36 @@
+require 'open-uri'
+
+module TelephoneAppointments
+  class Api
+    def post(path, form_data)
+      uri = URI.parse("#{api_uri}#{path}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.read_timeout = read_timeout
+      request = Net::HTTP::Post.new(uri.request_uri, headers)
+      request.set_form_data(form_data)
+
+      Response.new(http.request(request))
+    end
+
+    private
+
+    def headers
+      {}.tap do |hash|
+        hash['Authorization'] = "Bearer #{bearer_token}" if bearer_token
+        hash['Accept'] = 'application/json'
+      end
+    end
+
+    def bearer_token
+      ENV['TELEPHONE_APPOINTMENTS_API_BEARER_TOKEN']
+    end
+
+    def api_uri
+      ENV.fetch('TELEPHONE_APPOINTMENTS_API_URI', 'http://localhost:3001')
+    end
+
+    def read_timeout
+      ENV.fetch('TELEPHONE_APPOINTMENTS_API_READ_TIMEOUT', 5).to_i
+    end
+  end
+end

data/lib/telephone_appointments/response.rb

@@ -0,0 +1,20 @@
+module TelephoneAppointments
+  class Response
+    def initialize(response)
+      @response = response
+    end
+
+    def success?
+      response.is_a? Net::HTTPSuccess
+    end
+
+    def errors
+      return {} if success? || response.body.nil? || response.body == ''
+      JSON.parse(response.body)
+    end
+
+    private
+
+    attr_reader :response
+  end
+end

data/lib/telephone_appointments/stub_api.rb

@@ -0,0 +1,7 @@
+module TelephoneAppointments
+  class StubApi
+    def post(*)
+      Response.new(Net::HTTPSuccess.new(nil, nil, nil))
+    end
+  end
+end

data/lib/telephone_appointments/summary_document_activity.rb

@@ -0,0 +1,31 @@
+module TelephoneAppointments
+  class SummaryDocumentActivity
+    class InvalidDeliveryMethod < StandardError; end
+
+    VALID_DELIVERY_METHODS = %w(postal digital).freeze
+    PATH = '/api/v1/summary_documents'.freeze
+
+    def initialize(appointment_id:, owner_uid:, delivery_method:)
+      raise(InvalidDeliveryMethod, delivery_method) unless VALID_DELIVERY_METHODS.include?(delivery_method)
+
+      @appointment_id = appointment_id
+      @owner_uid = owner_uid
+      @delivery_method = delivery_method
+    end
+
+    def save
+      @response = TelephoneAppointments.api.post(
+        PATH,
+        appointment_id: @appointment_id,
+        owner_uid: @owner_uid,
+        delivery_method: @delivery_method
+      )
+      @response.success?
+    end
+
+    def errors
+      @response || raise(TelephoneAppointments::UnsavedObject, 'Please save the object before accessing the errors')
+      @response.errors
+    end
+  end
+end

data/lib/telephone_appointments/version.rb

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

data/lib/telephone_appointments.rb

@@ -0,0 +1,17 @@
+require 'telephone_appointments/version'
+require 'telephone_appointments/api'
+
+require 'telephone_appointments/response'
+require 'telephone_appointments/summary_document_activity'
+
+require 'active_support/core_ext/module/attribute_accessors'
+
+module TelephoneAppointments
+  mattr_writer :api
+
+  def self.api
+    @api ||= TelephoneAppointments::Api.new
+  end
+
+  class UnsavedObject < StandardError; end
+end

data/telephone_appointments.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'telephone_appointments/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'telephone_appointments'
+  spec.version       = TelephoneAppointments::VERSION
+  spec.authors       = ['David Henry']
+  spec.email         = ['david@decoybecoy.com']
+
+  spec.summary       = 'Pension Guidance Telephone Appointment Planner API adapter'
+  spec.homepage      = 'https://github.com/guidance-guarantee-programme/telephone_appointments'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '>= 4', '< 5.1'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: telephone_appointments
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Henry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- david@decoybecoy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/telephone_appointments.rb
+- lib/telephone_appointments/api.rb
+- lib/telephone_appointments/response.rb
+- lib/telephone_appointments/stub_api.rb
+- lib/telephone_appointments/summary_document_activity.rb
+- lib/telephone_appointments/version.rb
+- telephone_appointments.gemspec
+homepage: https://github.com/guidance-guarantee-programme/telephone_appointments
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Pension Guidance Telephone Appointment Planner API adapter
+test_files: []