breathe 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b556ec113d7d5c5f9666a7107c86707b4aa28bec7932eb7607c090631c07250c
-  data.tar.gz: c5b26bce036fd4324e154b0df6e68e10c94e441691e015bb2bb9cd5ac702dc52
+  metadata.gz: 50f00c9264cf4b355d988467f0410baeb78606cdc27ceba2e28a3e5671771f0c
+  data.tar.gz: 8d815287afcee0bd8e58281869ae4bbb86df13f37fe15498b03c48d7f591d0a0
 SHA512:
-  metadata.gz: f0af79e4598c36081ae9705f8b90bec086a54530a008644e4dbce0f7158094e32744d90f7f6677b232caa90cebd55851afaf31d4fe8bd9813b7d4471aa452ef6
-  data.tar.gz: 0fefc175a63493210d9c5c81e31b11539e5b08b77ac2e6d626285fdd7552846668cf2a4d670b2f59e742d71e48ffb0c65c6c7b799aaacc085a5887cca01e97f7
+  metadata.gz: 1a7dbf1a5cf986f68e924c86ae9a3e17f87bf7ef3ab4e66f2b3edea262b23b132d9de35c5aa3bd0fb8d80bc48889ce4c512b96ee707b5693016b8dc24694b87f
+  data.tar.gz: 5ab3b6c5fd7ab573b31804e593f1059ed1bc5a13d20819fe368baf8b9a844ed7a823b251382c46df15bcb535def9483710dbb59abe1dc0fe7ff13a91824e0c76

data/README.md

@@ -40,32 +40,7 @@ And use like so
 
 ```ruby
 client.absences.list
-#=> [
-#  {
-#    "employee"=>{"id"=>123, "email"=>"someone@somewhere.com", "first_name"=>"Jo", "last_name"=>"Bloggs"},
-#    "approved_by"=>{"id"=>123, "first_name"=>"Jo", "last_name"=>"Bloggs"},
-#   "leave_reason"=>nil,
-#    "deducted"=>"4.0",
-#    "work_units"=>"4.0",
-#    "id"=>456,
-#    "start_date"=>"2015-06-18",
-#    "half_start"=>false,
-#    "half_start_am_pm"=>nil,
-#    "end_date"=>"2015-06-23",
-#    "half_end"=>false,
-#    "half_end_am_pm"=>nil,
-#    "cancelled"=>true,
-#    "notes"=>"",
-#    "type"=>"Holiday",
-#    "created_at"=>"2015-05-20T15:53:36+01:00",
-#    "updated_at"=>"2015-06-11T13:58:27+01:00"
-#  },
-#  ...
-#]
-client.absences.list.next_page
-# 2
-client.absences.list.per_page
-# 100
+#=> [...]
 ```
 
 You can also pass in arguments like so:
@@ -75,6 +50,27 @@ client.absences(per_page: 12, start_date: Date.today)
 #=> [...]
 ```
 
+### Pagination
+
+You can also paginate through the data like so:
+
+```ruby
+client.absences.list.next_page
+#=> [...]
+client.absences.list.previous_page
+#=> [...]
+client.absences.list.last_page
+#=> [...]
+client.absences.list.first_pages
+#=> [..]
+```
+
+If you don't want to paginate at all, you can initialize the client with the `auto_paginate` argument set to `true` like so:
+
+```ruby
+client = Breathe::Client.new(api_key: YOUR_API_KEY, auto_paginate: true)
+```
+
 Only the absences endpoint is currently supported. PRs are accepted for more endpoints!
 
 ## Development

data/breathe.gemspec

@@ -34,5 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry", "~> 0.12.2"
   spec.add_development_dependency "webmock", "~> 3.7.6"
 
-  spec.add_dependency "faraday", "~> 0.17.0"
+  spec.add_dependency "sawyer", "~> 0.8.2"
 end

data/lib/breathe.rb

@@ -1,4 +1,4 @@
-require "faraday"
+require "sawyer"
 
 require "breathe/version"
 require "breathe/client"
@@ -9,5 +9,6 @@ require "breathe/absences"
 module Breathe
   class Error < StandardError; end
   class AuthenticationError < StandardError; end
+  class UnknownError < StandardError; end
   # Your code goes here...
 end

data/lib/breathe/absences.rb

@@ -7,8 +7,11 @@ module Breathe
     end
 
     def list(args = {})
-      response = client.get("absences", args)
-      Response.new(response, "absences")
+      client.response(
+        method: :get,
+        path: "absences",
+        args: args
+      )
     end
   end
 end

data/lib/breathe/client.rb

@@ -1,43 +1,49 @@
 module Breathe
   class Client
+    attr_reader :api_key, :last_response
+
     BASE_URL = "https://api.breathehr.com/v1/"
 
-    def initialize(api_key:)
+    def initialize(api_key:, auto_paginate: false)
       @api_key = api_key
+      @auto_paginate = auto_paginate
     end
 
     def absences
-      @_absences ||= Absences.new(self)
+      @absences ||= Absences.new(self)
+    end
+
+    def response(method:, path:, args:)
+      response = request(method: method, path: path, options: {query: args})
+      parsed_response = Response.new(response: response, type: path)
+
+      if parsed_response.success?
+        @auto_paginate ? auto_paginated_response(parsed_response) : parsed_response
+      end
     end
 
-    def get(url, url_opts = {})
-      request(:get, url, url_opts)
+    def agent
+      Sawyer::Agent.new(BASE_URL, links_parser: Sawyer::LinkParsers::Simple.new) do |http|
+        http.headers["Content-Type"] = "application/json"
+        http.headers["X-Api-Key"] = api_key
+      end
+    end
+
+    def request(method:, path:, data: {}, options: {})
+      @last_response = agent.call(method, path, data, options)
+      @last_response
     end
 
     private
 
-    attr_reader :api_key, :environment
+    def auto_paginated_response(parsed_response)
+      while (next_page = parsed_response.next_page)
+        break if next_page.nil?
 
-    def connection
-      Faraday.new(url: BASE_URL) do |faraday|
-        faraday.use Faraday::Response::RaiseError
-        faraday.adapter Faraday.default_adapter
+        parsed_response.concat(next_page)
       end
-    end
 
-    def request(method, url, url_opts = {})
-      connection.send(method) do |req|
-        req.url BASE_URL + url, url_opts
-        req.headers["Content-Type"] = "application/json"
-        req.headers["X-Api-Key"] = api_key
-      end
-    rescue Faraday::ClientError => e
-      case e.message
-      when /401/
-        raise Breathe::AuthenticationError, "The BreatheHR API returned a 401 error - are you sure you've set the correct API key?"
-      else
-        raise e
-      end
+      parsed_response
     end
   end
 end

data/lib/breathe/response.rb

@@ -1,53 +1,63 @@
 module Breathe
   class Response
     extend Forwardable
-    attr_reader :data, :type, :response
+    attr_reader :response, :type
 
     delegate [:each, :find, :select, :count, :[]] => :body
 
-    def initialize(response, type)
+    def initialize(response:, type:)
       @response = response
-      @data = JSON.parse(response.body)
       @type = type
     end
 
+    def concat(response)
+      @response = response.response
+      body.concat(response.body)
+    end
+
+    def body
+      @body ||= response.data[type]
+    end
+
     def total
       response.headers["total"].to_i
     end
 
     def per_page
-      response.headers.per_page
+      response.headers["per-page"].to_i
     end
 
-    def next_page
-      link_headers["next"].to_i unless link_headers.nil?
+    def first_page
+      get_page(:first)
     end
 
-    def last_page
-      link_headers["last"].to_i unless link_headers.nil?
+    def next_page
+      get_page(:next)
     end
 
-    private
+    def previous_page
+      get_page(:prev)
+    end
 
-    def body
-      data[type]
+    def last_page
+      get_page(:last)
     end
 
-    def link_headers
-      @link_headers ||= begin
-        return nil if response.headers["link"].nil?
+    def success?
+      return true if /^2+/.match?(response.status.to_s)
 
-        parse_link_headers(response.headers["link"])
+      case response.status
+      when 401
+        raise Breathe::AuthenticationError, "The BreatheHR API returned a 401 error - are you sure you've set the correct API key?"
+      else
+        raise Breathe::UnknownError, "The BreatheHR API returned an unknown error"
       end
     end
 
-    def parse_link_headers(header)
-      header.split(",").map { |header|
-        v, k = header.split(";")
-        k = k.match("rel=\"(.+)\"")[1]
-        v = v.match("page=([0-9]+)")[1]
-        [k, v]
-      }.to_h
+    private
+
+    def get_page(rel_type)
+      self.class.new(response: response.rels[rel_type].get, type: type) if response.rels[rel_type]
     end
   end
 end

data/lib/breathe/version.rb

@@ -1,3 +1,3 @@
 module Breathe
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breathe
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Stuart Harrison
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-08 00:00:00.000000000 Z
+date: 2019-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,19 +123,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.7.6
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: sawyer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.8.2
 description: 
 email:
 - pezholio@gmail.com