jbr 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c00c0f3ead7d9db2518cc70474af4639c1b6aa407a0ee9012abcf456d86095bc
-  data.tar.gz: '06924dba14bdaebb1e309ca824eb3cef19c4cbd51715033f0add17ea6917c3a3'
+  metadata.gz: 1acfc5eb08362100da536df933e8fdbde9edb2c3857970258731087766ebc9b1
+  data.tar.gz: 101d507d0b42e8c5f4f775db7e23ebbe4842ce5df46ced706dc7e4b261c41cac
 SHA512:
-  metadata.gz: 7925cb707094cae2a6007534bf1c4e7833cdacbc0651b4c0a37e20311405d8c8376c387f70fca14657799e77a339027c8da229f0c356c00080f308eb2a8333d1
-  data.tar.gz: f7545884b57cf5feb495d03853c0aa0a748ea05b02841bf612f30432da7561368deb331e7c9e954e7282ff5058d376a9677cddc7611a8085d8bc6985bd362548
+  metadata.gz: b39be9586f32d4e4729999690569fbd806c96aa095ee899e5fcb3232308ee82376bf9e45bf1627dcc7822416698258b923e4c694fa4fe2b1c35be0e6e1087bde
+  data.tar.gz: c8904ce193f0694f17793560f3d1f29c7cdab60b3f19be34b04e96cb1097d5deee6bcfa83762e49371c2d3e6f41c38671461cc2c017f76e19a63a43005e797bb

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.0.5] - 2026-05-24
+
+- [Feature] Add mocks to help apps test Jobber integration
+
 ## [1.0.3] - 2026-05-22
 
 - [Fix] Jobber returns invoice.issuedDate as a time, not as a date

data/README.md

@@ -2,10 +2,24 @@
 
 ## Available methods
 
-Initialize the authentication with a code:
+### Credentials
+
+Generate the URL for Jobber users to authorize the app:
+
+```ruby
+url = Jbr.oauth_url_for redirect_uri:, state:
+url # => 'https://api.getjobber.com/api/oauth/authorize?state=...&redirect_uri=...'
+
+Create credentials with a code and a redirect URI:
+
+```ruby
+oauth = Jbr.create_oauth code:, redirect_uri:
+```
+
+Initialize with existing credentials:
 
 ```ruby
-oauth = Jbr::OAuth.create code: code, redirect_uri: jobber_callback_url
+oauth = Jbr.oauth_for access_token:, refresh_token, expires_at:, account_id:
 ```
 
 Access OAuth attributes:
@@ -17,6 +31,14 @@ oauth.expires_at # => 2026-05-22 14:32:53
 oauth.account_id # => 'Z2lkOi8vSm9iYmV'
 ````
 
+Revoke credentials:
+
+```ruby
+oauth.delete
+```
+
+### Requests
+
 Create a Jobber request, finding or creating a Client with a matching phone number:
 
 ```ruby
@@ -26,7 +48,9 @@ request.id # => 'Z2lkOi8vSm9iYmVyL'
 request.client_id # => 'MwMTU0Mg'
 ```
 
-Fetches a quote from Jobber:
+### Quotes
+
+Fetch a quote from Jobber:
 
 ```ruby
 quote = oauth.quotes.find 'Z2lkOi8vS'
@@ -34,7 +58,9 @@ quote.id # => 'Z2lkOi8vS'
 quote.request_id # => 'Z2lkOi8vSm9iYmVyL'
 ```
 
-Fetches a job from Jobber:
+### Jobs
+
+Fetch a job from Jobber:
 
 ```ruby
 job = oauth.jobs.find 'Njc5MTk5'
@@ -44,7 +70,9 @@ job.scheduled_at # => 2026-05-14 23:02:52
 job.completed_at # => 2026-05-18 11:36:13
 ```
 
-Fetches a non-draft invoice from Jobber:
+### Invoices
+
+Fetch a non-draft invoice from Jobber:
 
 ```ruby
 invoice = oauth.invoices.find 'MjU3ODA0'
@@ -55,10 +83,58 @@ invoice.issued_at # => 2026-05-22 12:12:53
 invoice.completed_at # => 2026-05-22 14:32:53
 ```
 
+## Available mocks
+
+Use these methods to mock request to Jobber when testing an app:
 
-Revoke authentication:
+### Credentials
+
+Mock successfully creating and revoking credentials:
 
 ```ruby
-oauth.delete
+Jbr.mock
+```
+
+Mock an error when creating credentials:
+
+```ruby
+Jbr.mock.oauth_error = 'Flow rejected'
 ```
 
+Mock a custom redirect URL:
+
+```ruby
+Jbr.mock.oauth_url_for = 'https://example.com'
+```
+
+### Requests
+
+Mock successfully creating a request:
+
+```ruby
+Jbr.mock.request = { id: 'request-01', client_id: 'client-01' }
+```
+
+### Quotes
+
+Mock successfully fetching a quote:
+
+```ruby
+Jbr.mock.quote = { id: 'quote-01', request_id: 'request-01' }
+```
+
+### Jobs
+
+Mock successfully fetching a job:
+
+```ruby
+Jbr.mock.job = { id: 'job-01', quote_id: 'quote-01', scheduled_at: Date.tomorrow.noon }
+```
+
+### Invoices
+
+Mock successfully fetching an invoice:
+
+```ruby
+Jbr.mock.invoice = { id: 'invoice-01', job_id: 'job-01', total: 19.99, issued_at: Date.yesterday.noon }
+```

data/lib/graphql/client.rb

@@ -0,0 +1,34 @@
+require 'json'
+require 'net/http'
+
+# A minimal GraphQL client used to talk to third-party APIs.
+module GraphQL
+  # An HTTP wrapper that posts queries to a GraphQL endpoint and returns the `data` payload.
+  class Client
+    # @param endpoint [String] the GraphQL endpoint URL.
+    # @param token [String] the bearer access token used to authorize the request.
+    # @param headers [Hash] any extra headers required by the API (e.g. a version pin).
+    def initialize(endpoint:, token:, headers: {})
+      @endpoint = URI endpoint
+      @token = token
+      @headers = headers
+    end
+
+    # @param query [String] the GraphQL query string.
+    # @param variables [Hash] the variables to interpolate into the query.
+    # @return [Hash] the `data` portion of the GraphQL response.
+    def query(query, variables: {})
+      response = Net::HTTP.post @endpoint, { query:, variables: }.to_json, request_headers
+      raise Unauthorized, response.body if response.code == '401'
+      raise Error, response.body unless response.is_a? Net::HTTPSuccess
+      body = JSON.parse(response.body)
+      raise Error, body['errors'].pluck('message').join('; ') if body['errors'].present?
+      body.fetch('data')
+    end
+
+  private
+    def request_headers
+      { 'Authorization' => "Bearer #{@token}", 'Content-Type' => 'application/json' }.merge @headers
+    end
+  end
+end

data/lib/graphql/error.rb

@@ -0,0 +1,5 @@
+module GraphQL
+  # An error raised when a GraphQL request fails.
+  class Error < StandardError
+  end
+end

data/lib/graphql/unauthorized.rb

@@ -0,0 +1,5 @@
+module GraphQL
+  # An error raised when the API rejects the access token (HTTP 401).
+  class Unauthorized < Error
+  end
+end

data/lib/jbr/configuration.rb

@@ -0,0 +1,5 @@
+module Jbr
+  class Configuration
+    attr_accessor :mock_account, :mock_request, :mock_auth, :mock_auth_error, :mock_disconnect, :mock_invoice, :mock_job, :mock_quote, :mock_redirect_url
+  end
+end

data/lib/jbr/mock/account.rb

@@ -0,0 +1,5 @@
+module Jbr
+  class Mock::Account < Account
+    def id = 'account-01'
+  end
+end

data/lib/jbr/mock/invoice.rb

@@ -0,0 +1,15 @@
+module Jbr
+  class Mock::Invoice < Invoice
+    def find(_)
+      @id = Jbr.mock.invoice[:id]
+      @job_id = Jbr.mock.invoice[:job_id]
+      @total = Jbr.mock.invoice[:total]
+
+      self
+    end
+
+    def issued_at = Jbr.mock.invoice[:issued_at]
+
+    def completed_at = Jbr.mock.invoice[:completed_at]
+  end
+end

data/lib/jbr/mock/job.rb

@@ -0,0 +1,14 @@
+module Jbr
+  class Mock::Job < Job
+    def find(_)
+      @id = Jbr.mock.job[:id]
+      @quote_id = Jbr.mock.job[:quote_id]
+
+      self
+    end
+
+    def scheduled_at = Jbr.mock.job[:scheduled_at]
+
+    def completed_at = Jbr.mock.job[:completed_at]
+  end
+end

data/lib/jbr/mock/oauth.rb

@@ -0,0 +1,19 @@
+module Jbr
+  class Mock::OAuth < OAuth
+    def invoices = Mock::Invoice.new(oauth: self)
+    def jobs = Mock::Job.new(oauth: self)
+    def quotes = Mock::Quote.new(oauth: self)
+    def requests = Mock::Request.new(oauth: self)
+    def account = Mock::Account.new oauth: self
+
+    def delete; end
+
+  private
+
+    def self.post(_)
+      raise Error, error: Jbr.mock.oauth_error if Jbr.mock.oauth_error
+
+      { access_token: 'mock-token', refresh_token: 'mock-token', expires_at: (Time.current + 3600) }
+    end
+  end
+end

data/lib/jbr/mock/quote.rb

@@ -0,0 +1,10 @@
+module Jbr
+  class Mock::Quote < Quote
+    def find(_)
+      @id = Jbr.mock.quote[:id]
+      @request_id = Jbr.mock.quote[:request_id]
+
+      self
+    end
+  end
+end

data/lib/jbr/mock/request.rb

@@ -0,0 +1,10 @@
+module Jbr
+  class Mock::Request < Request
+    def create(_)
+      @id = Jbr.mock.request[:id]
+      @client_id = Jbr.mock.request[:client_id]
+
+      self
+    end
+  end
+end

data/lib/jbr/mock/url.rb

@@ -0,0 +1,7 @@
+module Jbr
+  class Mock::URL < URL
+    def self.for(_)
+      Jbr.mock.oauth_url
+    end
+  end
+end

data/lib/jbr/mock.rb

@@ -0,0 +1,5 @@
+module Jbr
+  class Mock
+    attr_accessor :quote, :job, :invoice, :request, :oauth_url, :oauth_error
+  end
+end

data/lib/jbr/mocking.rb

@@ -0,0 +1,21 @@
+module Jbr
+  module Mocking
+    def mock
+      @mock ||= Jbr::Mock.new
+    end
+
+    def create_oauth(params = {})
+      (@mock ? Mock::OAuth : OAuth).create **params
+    end
+
+    def oauth_url_for(params = {})
+      (@mock ? Mock::URL : URL).for **params
+    end
+
+    def oauth_for(params = {})
+      (@mock ? Mock::OAuth : OAuth).new params
+    end
+  end
+
+  extend Mocking
+end

data/lib/jbr/oauth.rb

@@ -74,11 +74,5 @@ module Jbr
     end
 
     def headers = { 'X-JOBBER-GRAPHQL-VERSION' => '2026-04-22' }
-
-    def self.url_for(params = {})
-      uri = URI 'https://api.getjobber.com/api/oauth/authorize'
-      uri.query ||= params.merge(response_type: 'code', client_id: client_id).to_query
-      uri.to_s
-    end
   end
 end

data/lib/jbr/url.rb

@@ -0,0 +1,13 @@
+module Jbr
+  class URL
+    def self.for(params = {})
+      uri = URI 'https://api.getjobber.com/api/oauth/authorize'
+      uri.query ||= params.merge(response_type: 'code', client_id: client_id).to_query
+      uri.to_s
+    end
+
+  private
+
+    def self.client_id = ENV['JOBBER_CLIENT_ID']
+  end
+end

data/lib/jbr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jbr
-  VERSION = '1.0.3'
+  VERSION = '1.0.5'
 end

data/lib/jbr.rb

@@ -3,6 +3,13 @@
 require 'json'
 require 'net/http'
 
+require 'graphql/error'
+require 'graphql/unauthorized'
+require 'graphql/client'
+
+require 'jbr/mock'
+
+require 'jbr/url'
 require 'jbr/error'
 require 'jbr/resource'
 require 'jbr/request'
@@ -13,3 +20,13 @@ require 'jbr/client'
 require 'jbr/invoice'
 require 'jbr/job'
 require 'jbr/quote'
+
+require 'jbr/mock/oauth'
+require 'jbr/mock/quote'
+require 'jbr/mock/job'
+require 'jbr/mock/invoice'
+require 'jbr/mock/request'
+require 'jbr/mock/account'
+require 'jbr/mock/url'
+
+require 'jbr/mocking'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jbr
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -19,16 +19,30 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- lib/graphql/client.rb
+- lib/graphql/error.rb
+- lib/graphql/unauthorized.rb
 - lib/jbr.rb
 - lib/jbr/account.rb
 - lib/jbr/client.rb
+- lib/jbr/configuration.rb
 - lib/jbr/error.rb
 - lib/jbr/invoice.rb
 - lib/jbr/job.rb
+- lib/jbr/mock.rb
+- lib/jbr/mock/account.rb
+- lib/jbr/mock/invoice.rb
+- lib/jbr/mock/job.rb
+- lib/jbr/mock/oauth.rb
+- lib/jbr/mock/quote.rb
+- lib/jbr/mock/request.rb
+- lib/jbr/mock/url.rb
+- lib/jbr/mocking.rb
 - lib/jbr/oauth.rb
 - lib/jbr/quote.rb
 - lib/jbr/request.rb
 - lib/jbr/resource.rb
+- lib/jbr/url.rb
 - lib/jbr/version.rb
 homepage: https://github.com/HouseAccountEng/jbr
 licenses: