mojfile-uploader-api-client 0.1.0

data/.ruby-version

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,143 @@
+PATH
+  remote: .
+  specs:
+    mojfile-uploader-api-client (0.1.0)
+      rest-client (~> 2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    anima (0.3.0)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2)
+      equalizer (~> 0.0.11)
+    ast (2.3.0)
+    byebug (9.0.6)
+    codeclimate-test-reporter (0.6.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.1)
+    concord (0.1.5)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.20161021)
+      unf (>= 0.0.5, < 1.0.0)
+    equalizer (0.0.11)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    ice_nine (0.11.2)
+    json (2.0.2)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    morpher (0.2.6)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      anima (~> 0.3.0)
+      ast (~> 2.2)
+      concord (~> 0.1.5)
+      equalizer (~> 0.0.9)
+      ice_nine (~> 0.11.0)
+      procto (~> 0.0.2)
+    mutant (0.8.12)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      anima (~> 0.3.0)
+      ast (~> 2.2)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.2)
+      equalizer (~> 0.0.9)
+      ice_nine (~> 0.11.1)
+      memoizable (~> 0.4.2)
+      morpher (~> 0.2.6)
+      parallel (~> 1.3)
+      parser (~> 2.3.1, >= 2.3.1.4)
+      procto (~> 0.0.2)
+      regexp_parser (~> 0.3.6)
+      unparser (~> 0.2.5)
+    mutant-rspec (0.8.11)
+      mutant (~> 0.8.11)
+      rspec-core (>= 3.4.0, < 3.6.0)
+    netrc (0.11.0)
+    parallel (1.10.0)
+    parser (2.3.2.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    procto (0.0.3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.1)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    regexp_parser (0.3.6)
+    rest-client (2.0.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.45.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+    unicode-display_width (1.1.1)
+    unparser (0.2.5)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.2.5)
+      equalizer (~> 0.0.9)
+      parser (~> 2.3.0)
+      procto (~> 0.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  codeclimate-test-reporter (~> 0.2)
+  mojfile-uploader-api-client!
+  mutant-rspec (~> 0.8)
+  pry-byebug (~> 3.4)
+  rake (~> 10.0)
+  rspec (~> 3.5)
+  rubocop (~> 0.41)
+
+BUNDLED WITH
+   1.13.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 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/README.md

@@ -0,0 +1,94 @@
+# mojfile-uploader-api-client
+An API client for mojfile-uploader
+
+## Configuration
+
+In your project, create an initializer with the following:
+
+```ruby
+MojFileUploaderApiClient::HttpClient.configure do |client|
+  client.base_url = 'http://localhost:3003' # mandatory
+  client.options = {} # optional - supports :headers, :verify_ssl, :open_timeout, :read_timeout
+end
+```
+
+## Operations
+
+### Add a file
+
+#### When a previous collection reference is known:
+
+```ruby
+MojFileUploaderApiClient::AddFile.new(title: 'test', filename: 'test.txt', data: 'bla bla bla', collection_ref: 'a45c556f-a628-41d3-8c29-351f84e63757').call
+
+=> #<MojFileUploaderApiClient::Response:0x007fe4e5c85ce0
+ @body={:collection=>"a45c556f-a628-41d3-8c29-351f84e63757", :key=>"7c6aca2c-eb7a-4194-8166-9fd6ac82127b.test.txt"},
+ @code=200>
+```
+
+#### No previous collection reference (will create a new one):
+
+```ruby
+MojFileUploaderApiClient::AddFile.new(title: 'test', filename: 'test.txt', data: 'bla bla bla').call
+
+=> #<MojFileUploaderApiClient::Response:0x007fe4e5b8cc58
+ @body={:collection=>"741635f7-488a-49cc-a3f1-9ee38795e28e", :key=>"0543a21d-e884-4076-89be-41cc09b00da1.test.txt"},
+ @code=200>
+```
+
+### Delete a file
+
+```ruby
+MojFileUploaderApiClient::DeleteFile.new(collection_ref: 'a45c556f-a628-41d3-8c29-351f84e63757', filename: 'test1.txt').call
+=> #<MojFileUploaderApiClient::Response:0x007fe4e59c8098 @body={:body_parser_error=>"743: unexpected token at ''"}, @code=204>
+```
+
+### List files
+
+```ruby
+MojFileUploaderApiClient::ListFiles.new(collection_ref: 'a45c556f-a628-41d3-8c29-351f84e63757').call
+=> #<MojFileUploaderApiClient::Response:0x007fe4e5ac91e0
+ @body=
+  {:collection=>"a45c556f-a628-41d3-8c29-351f84e63757",
+   :files=>[{:key=>"a45c556f-a628-41d3-8c29-351f84e63757/test1.txt", :title=>"test1.txt", :last_modified=>"2016-11-30T15:30:52.000Z"}]},
+ @code=200>
+```
+
+## Contributing
+
+Fork, then clone the repo:
+
+```bash
+git clone git@github.com:your-username/mojfile-uploader-api-client.git
+```
+
+Make sure the tests pass:
+
+```bash
+bundle exec rake
+```
+
+Make your change. Add specs for your change. Make the specs pass:
+
+```bash
+bundle exec rake
+```
+
+Push to your fork and [submit a pull request][pr].
+
+[pr]: https://github.com/ministryofjustice/mojfile-uploader-api-client/compare
+
+Some things that will increase the chance that your pull request is
+accepted:
+
+* Write specs.
+* Make sure you don’t have any mutants (part of total test suite).
+* Write a [good commit message][commit].
+
+[commit]: https://github.com/alphagov/styleguides/blob/master/git.md
+
+## License
+
+Released under the [MIT License](http://opensource.org/licenses/MIT).
+Copyright (c) 2016 Ministry of Justice.
+

data/Rakefile

@@ -0,0 +1,30 @@
+# begin
+#   require 'bundler/setup'
+# rescue LoadError
+#   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+# end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MojFileUploaderApiClient'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+# Get rid of rspec background noise.
+task(:spec).clear
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
+task default: :spec
+
+load 'tasks/mutant.rake'
+load 'tasks/rubocop.rake'

data/circle.yml

@@ -0,0 +1,7 @@
+database:
+  override:
+   - touch 'not needed'
+
+test:
+  override:
+    - bundle exec rake

data/lib/mojfile_uploader_api_client/add_file.rb

@@ -0,0 +1,24 @@
+module MojFileUploaderApiClient
+  class AddFile < MojFileUploaderApiClient::HttpClient
+    attr_accessor :collection_ref, :title, :filename, :data
+
+    def initialize(collection_ref: nil, title:, filename:, data:)
+      self.collection_ref = collection_ref
+      self.title = title
+      self.filename = filename
+      self.data = data
+    end
+
+    def verb
+      :post
+    end
+
+    def payload
+      {file_title: title, file_filename: filename, file_data: data}
+    end
+
+    def endpoint
+      File.join(collection_ref.to_s, 'new')
+    end
+  end
+end

data/lib/mojfile_uploader_api_client/delete_file.rb

@@ -0,0 +1,18 @@
+module MojFileUploaderApiClient
+  class DeleteFile < MojFileUploaderApiClient::HttpClient
+    attr_accessor :collection_ref, :filename
+
+    def initialize(collection_ref:, filename:)
+      self.collection_ref = collection_ref
+      self.filename = filename
+    end
+
+    def verb
+      :delete
+    end
+
+    def endpoint
+      [collection_ref, filename].join('/')
+    end
+  end
+end

data/lib/mojfile_uploader_api_client/file_reference.rb

@@ -0,0 +1,13 @@
+# Note: Decide if go with building `file` objects or instead using the uploader API json response directly
+#
+module MojFileUploaderApiClient
+  class FileReference
+    attr_accessor :key, :title, :last_modified
+
+    def initialize(key:, title:, last_modified:)
+      self.key = key
+      self.title = title
+      self.last_modified = last_modified
+    end
+  end
+end

data/lib/mojfile_uploader_api_client/http_client.rb

@@ -0,0 +1,66 @@
+module MojFileUploaderApiClient
+  class HttpClient
+    attr_accessor :response
+
+    DEFAULT_OPTIONS = {
+      headers: {'Content-Type' => 'application/json', 'Accept' => 'application/json'},
+      verify_ssl: false,
+      open_timeout: 5,
+      read_timeout: 15
+    }.freeze
+
+    class << self
+      attr_accessor :base_url, :options
+
+      def configure
+        yield(self)
+      end
+    end
+
+    def call
+      execute_request
+      response
+    end
+
+    def endpoint
+      raise 'not implemented'
+    end
+
+    def verb
+      raise 'not implemented'
+    end
+
+    def payload; end
+
+    def payload?
+      !payload.nil?
+    end
+
+    def options
+      DEFAULT_OPTIONS.merge(HttpClient.options || {})
+    end
+
+    private
+
+    def url
+      File.join(HttpClient.base_url, endpoint)
+    end
+
+    def request_details
+      {method: verb, url: url}.merge(options).tap do |args|
+        args.merge!(payload: payload.to_json) if payload?
+      end
+    end
+
+    def execute_request
+      begin
+        res = RestClient::Request.execute(request_details)
+        code, body = res.code, res.body
+      rescue RestClient::Exception => ex
+        code, body = ex.http_code, ex.response
+      end
+
+      self.response = Response.new(code: code, body: body)
+    end
+  end
+end

data/lib/mojfile_uploader_api_client/list_files.rb

@@ -0,0 +1,17 @@
+module MojFileUploaderApiClient
+  class ListFiles < MojFileUploaderApiClient::HttpClient
+    attr_accessor :collection_ref
+
+    def initialize(collection_ref:)
+      self.collection_ref = collection_ref
+    end
+
+    def verb
+      :get
+    end
+
+    def endpoint
+      collection_ref
+    end
+  end
+end

data/lib/mojfile_uploader_api_client/response.rb

@@ -0,0 +1,27 @@
+module MojFileUploaderApiClient
+  class Response
+    attr_accessor :code, :body
+
+    def initialize(code:, body:)
+      self.code = code
+      self.body = parse_body(body)
+    end
+
+    def success?
+      [200, 204].include?(code)
+    end
+
+    def error?
+      !success?
+    end
+
+    private
+
+    def parse_body(body)
+      return body if ['', nil].include?(body)
+      JSON.parse(body, symbolize_names: true)
+    rescue JSON::ParserError => ex
+      {body_parser_error: ex.message}
+    end
+  end
+end

data/lib/mojfile_uploader_api_client/status.rb

@@ -0,0 +1,22 @@
+module MojFileUploaderApiClient
+  class Status < MojFileUploaderApiClient::HttpClient
+
+    def verb
+      :get
+    end
+
+    def endpoint
+      'status'
+    end
+
+    def available?
+      response.success? && status.eql?('OK')
+    end
+
+    private
+
+    def status
+      response.body&.fetch(:status)
+    end
+  end
+end

data/lib/mojfile_uploader_api_client/version.rb

@@ -0,0 +1,3 @@
+module MojFileUploaderApiClient
+  VERSION = '0.1.0'
+end

data/lib/mojfile_uploader_api_client.rb

@@ -0,0 +1,15 @@
+require 'json'
+require 'rest-client'
+require 'mojfile_uploader_api_client/version'
+require 'mojfile_uploader_api_client/response'
+require 'mojfile_uploader_api_client/http_client'
+require 'mojfile_uploader_api_client/file_reference'
+require 'mojfile_uploader_api_client/status'
+require 'mojfile_uploader_api_client/add_file'
+require 'mojfile_uploader_api_client/delete_file'
+require 'mojfile_uploader_api_client/list_files'
+
+module MojFileUploaderApiClient
+  class Unavailable < StandardError; end
+  class RequestError < StandardError; end
+end

data/lib/tasks/mutant.rake

@@ -0,0 +1,9 @@
+task :mutant do
+  vars = 'NOCOVERAGE=true'
+  flags = '--include lib --use rspec --fail-fast'
+  unless system("#{vars} mutant #{flags} MojFileUploaderApiClient*")
+    raise 'Mutation testing failed'
+  end
+end
+
+task(:default).prerequisites << task(:mutant)

data/lib/tasks/rubocop.rake

@@ -0,0 +1,6 @@
+if Gem.loaded_specs.key?('rubocop')
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+
+  task(:default).prerequisites << task(:rubocop)
+end

data/mojfile_uploader_api_client.gemspec

@@ -0,0 +1,26 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+require 'mojfile_uploader_api_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'mojfile-uploader-api-client'
+  spec.version = MojFileUploaderApiClient::VERSION
+  spec.authors = ['Jesus Laiz', 'Tax Tribunals Fees']
+  spec.email = ['jesus.laiz@digital.justice.gov.uk', 'taxtribsfees@digital.justice.gov.uk']
+
+  spec.summary = 'API client for integration with the MOJ File Uploader'
+  spec.homepage = 'https://github.com/ministryofjustice/mojfile-uploader-api-client'
+  spec.licenses = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.2'
+  spec.add_development_dependency 'mutant-rspec', '~> 0.8'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.41'
+
+  spec.add_dependency 'rest-client', '~> 2.0.0'
+end