fountain 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3f653218c512db55d5962968cd24d27ddd397d9
-  data.tar.gz: 4de91be1284cec1b666cff24fa6f125faf00f272
+  metadata.gz: a99befaad758ca023d25977f69894c365f0ef0df
+  data.tar.gz: 65affa8bb6929cd6ed9cb239a2ab84abb1231a5e
 SHA512:
-  metadata.gz: 134cd04804537aa3e18752ff099491bd99e92391eef01b95c10d9b02856ea7d514eca255cf412ddb9e611dcfd496b1d75513e502610f43cd023ddfa192cf1192
-  data.tar.gz: f3b60a48988a06d3727e5e292b7a690e1d9430f52c6c8c93d777c2c84d688fc4e2a3a911fc086fa2a1cbfe9c561cec31d9cf6f39e0fa83174e168272d63c8ea2
+  metadata.gz: 737b8f67303d80b8343649b926e034b058a50ae1c590c6ed26cebfa6b871aa86c7f01a2813e39dd9ec71318796adfeec26b2c1088a9a59e4cfc29fe86e2f7de1
+  data.tar.gz: 28677cf2804ec759ea3b9f14713c235081df80c01a6ace4d6c9e36e9d124fe1f28b7bd92b4c3fbf1e79e1f24c73497c40d352aa47b6618adc9a7d365f59918f9

data/README.md

@@ -1,7 +1,7 @@
-[![Travis Build Status](http://img.shields.io/travis/Studiosity/fountain-ruby.svg?style=flat)](https://travis-ci.org/Studiosity/fountain-ruby)
+[![Travis Build Status](https://travis-ci.org/Studiosity/fountain-ruby.svg?branch=master)](https://travis-ci.org/Studiosity/fountain-ruby)
 [![Maintainability](https://api.codeclimate.com/v1/badges/0820e34b69a0dc3a7e8b/maintainability)](https://codeclimate.com/github/Studiosity/fountain-ruby/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/0820e34b69a0dc3a7e8b/test_coverage)](https://codeclimate.com/github/Studiosity/fountain-ruby/test_coverage)
-[![Gem Version](http://img.shields.io/gem/v/fountain.svg?style=flat)](#)
+[![Gem Version](https://badge.fury.io/rb/fountain.svg)](https://badge.fury.io/rb/fountain)
 
 # Fountain REST API for Ruby
 
@@ -18,3 +18,54 @@ gem 'fountain'
 And then execute:
 
     $ bundle
+
+## Supported API calls
+
+#### Applicant Management
+List, create, delete, get, update applicant etc
+
+See https://developer.fountain.com/docs/applicants
+
+## Usage
+
+First, initialise the Fountain API token
+
+```ruby
+Fountain.configure do |config|
+  config.api_token = 'YOUR-FOUNTAIN-API-TOKEN'
+end
+```
+
+#### List all applicants
+```ruby
+applicants = Fountain::Api::Applicants.list
+loop do
+  break if applicants.count.zero?
+  applicants.each do |applicant|
+    # Do something with the applicant
+  end
+  applicants = Fountain::Api::Applicants.list(cursor: applicants.next_cursor)
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Studiosity/fountain-ruby.
+
+Note that spec tests are appreciated to minimise regressions. Before submitting a PR, please ensure that:
+ 
+```bash
+$ rspec
+```
+
+and
+
+```bash
+$ rubocop
+```
+
+both succeed 
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/fountain.rb

@@ -22,9 +22,11 @@ require 'fountain/background_check'
 require 'fountain/booked_slot'
 require 'fountain/document_signature'
 require 'fountain/funnel'
+require 'fountain/label'
 require 'fountain/secure_document'
 require 'fountain/stage'
 require 'fountain/transition'
 
 require 'fountain/api/request_helper'
 require 'fountain/api/applicants'
+require 'fountain/api/labels'

data/lib/fountain/api/applicants.rb

@@ -1,7 +1,7 @@
 module Fountain
   module Api
     #
-    # Fountain Applicant API
+    # Fountain Applicant Management API
     #
     class Applicants
       extend RequestHelper

data/lib/fountain/api/labels.rb

@@ -0,0 +1,51 @@
+require 'date'
+
+module Fountain
+  module Api
+    #
+    # Fountain Label Management API
+    #
+    class Labels
+      extend RequestHelper
+
+      #
+      # List Labels for an Applicant
+      # @param [String] applicant_id ID of the Fountain applicant
+      # @return [[Fountain::Label]]
+      def self.applicant_labels(applicant_id)
+        response = request_json("/v2/applicants/#{applicant_id}/labels")
+        response['labels'].map { |hash| Fountain::Label.new hash }
+      end
+
+      #
+      # Update Label for an Applicant
+      # @param [String] applicant_id ID of the Fountain applicant
+      # @param [String] title ID of the Fountain applicant
+      # @param [Hash] update_options A hash of options to update applicant labels
+      #                 completed
+      #                 completed_at - Date the label was completed
+      # @return [[Fountain::Label]]
+      def self.update_applicant_label(applicant_id, title, update_options = {})
+        filtered_options = Util.slice_hash(update_options, :completed, :completed_at)
+        if filtered_options[:completed_at].is_a? Date
+          filtered_options[:completed_at] = filtered_options[:completed_at].strftime('%F')
+        end
+        response = request_json(
+          "/v2/applicants/#{applicant_id}/labels/#{URI.encode(title)}",
+          method: :put,
+          body: filtered_options
+        )
+        response['labels'].map { |hash| Fountain::Label.new hash }
+      end
+
+      #
+      # List Labels for a Stage
+      # @param [String] stage_id ID of the Fountain stage
+      # @return [[Fountain::Label]]
+      def self.stage_labels(stage_id)
+        response = request_json("/v2/stages/#{stage_id}/labels")
+        response['labels'].map { |hash| Fountain::Label.new hash }
+      end
+    end
+  end
+end

data/lib/fountain/gem_version.rb

@@ -1,3 +1,3 @@
 module Fountain
-  VERSION = '0.0.6'.freeze
+  VERSION = '0.0.7'.freeze
 end

data/lib/fountain/label.rb

@@ -0,0 +1,35 @@
+module Fountain
+  #
+  # Fountain Label
+  #
+  class Label
+    # Raw label data
+    attr_reader :raw_data
+
+    #
+    # @param [Hash] data Raw label data
+    #
+    def initialize(data)
+      @raw_data = Util.stringify_hash_keys data
+    end
+
+    # Label title
+    def title
+      raw_data['title']
+    end
+
+    # Completed
+    def completed
+      raw_data['completed']
+    end
+
+    def inspect
+      format(
+        '#<%<class_name>s:0x%<object_id>p @title="%<title>s">',
+        class_name: self.class.name,
+        object_id: object_id,
+        title: title
+      )
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fountain
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - abrom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2018-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,6 +113,7 @@ files:
 - fountain.gemspec
 - lib/fountain.rb
 - lib/fountain/api/applicants.rb
+- lib/fountain/api/labels.rb
 - lib/fountain/api/request_helper.rb
 - lib/fountain/applicant.rb
 - lib/fountain/applicants.rb
@@ -122,6 +123,7 @@ files:
 - lib/fountain/document_signature.rb
 - lib/fountain/funnel.rb
 - lib/fountain/gem_version.rb
+- lib/fountain/label.rb
 - lib/fountain/secure_document.rb
 - lib/fountain/stage.rb
 - lib/fountain/transition.rb