jbr 0.1.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc9bc9183104444f2ae6ef18f456a4053272f4b18a9d69cfbdc8a203528b9ccb
-  data.tar.gz: 2d72fd9fad3344c30ab9db19accecd336ec83a6b3b030c875ccd00d103a45dd3
+  metadata.gz: 9a1fb03ffa4daca5169eaad910f2827a11aee58c2ba49bf8bb7cc783e16cbb5b
+  data.tar.gz: ac95d6fa65c22bd24975c5ba559a1bda62dfd62fdf9f45c9875a60ea1c8e55c8
 SHA512:
-  metadata.gz: 496ecd2ea07ac0f14dfe83b74f2a5ceb318cd7d261f604f351702a20ef2aa2f942ae26dfb9f90a89b5dbb5f708efbbe58947c56cc4fb53d10d0ccd63b1f96f31
-  data.tar.gz: 221b746aba0ac320f6757462b8600ebdac914ccb943f5988d3a69791f47050aa79a66b7795f37201345b0fff8237b19fe7f5a9077dcc70df55ebc3a318490eac
+  metadata.gz: e3cc394c967fc81fb75ca6abd53e6f2d9f6777b61f44e492a96b44e2e06c091bc4b180b12cd7218578eef76c5368b76d9075830e55dbb9f7e8a793c8fef4a3d6
+  data.tar.gz: 13b17df1cd0f40caafd12d6cfcfc35cff33aa3580fbf12a69b28fdc7c279dda89b3bee03a35a86597dabd4cc27f7a7563c875211c53770684ff2a482c5af0814

data/CHANGELOG.md

@@ -1,5 +1,7 @@
-## [Unreleased]
+## [1.0.2] - 2026-05-22
 
-## [0.1.0] - 2026-05-15
+- [Fix] Ensure .find returns nil if the Jobber resource is not found
 
-- Initial release
+## [1.0.0] - 2026-05-15
+
+- Initial release: OAuth, Request, Client, Quote, Job, Invoice, Account classes

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2026 claudiob
+Copyright (c) 2026 HouseAccount
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,39 +1,64 @@
-# Jbr
+# Jobber API Ruby client
 
-TODO: Delete this and the text below, and describe your gem
+## Available methods
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jbr`. To experiment with that code, run `bin/console` for an interactive prompt.
+Initialize the authentication with a code:
 
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+```ruby
+oauth = Jbr::OAuth.create code: code, redirect_uri: jobber_callback_url
+```
 
-Install the gem and add to the application's Gemfile by executing:
+Access OAuth attributes:
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+oauth.access_token # => 'eyJhbGciOiJIUzI1NiJ'
+oauth.refresh_token # => 'ea02775958c5fca28d'
+oauth.expires_at # => 2026-05-22 14:32:53
+oauth.account_id # => 'Z2lkOi8vSm9iYmV'
+````
+
+Create a Jobber request, finding or creating a Client with a matching phone number:
+
+```ruby
+request = oauth.requests.create first_name: 'Jane', last_name: 'Doe', phone: '5553335555',
+  email: 'jane@example.com', title: 'New Plumber Lead', instructions: 'Needs new faucet'
+request.id # => 'Z2lkOi8vSm9iYmVyL'
+request.client_id # => 'MwMTU0Mg'
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Fetches a quote from Jobber:
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+quote = oauth.quotes.find 'Z2lkOi8vS'
+quote.id # => 'Z2lkOi8vS'
+quote.request_id # => 'Z2lkOi8vSm9iYmVyL'
 ```
 
-## Usage
-
-TODO: Write usage instructions here
+Fetches a job from Jobber:
 
-## Development
+```ruby
+job = oauth.jobs.find 'Njc5MTk5'
+job.id # => 'Z2lkOi8vS'
+job.quote_id # => 'Z2lkOi8vS'
+job.scheduled_at # => 2026-05-14 23:02:52
+job.completed_at # => 2026-05-18 11:36:13
+```
 
-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.
+Fetches a non-draft invoice from Jobber:
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+invoice = oauth.invoices.find 'MjU3ODA0'
+invoice.id # => 'MjU3ODA0'
+invoice.job_id # => 'Z2lkOi8vS'
+invoice.total # => '40.30'
+invoice.issued_date # => 2026-05-22
+invoice.completed_at # => 2026-05-22 14:32:53
+```
 
-## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jbr.
+Revoke authentication:
 
-## License
+```ruby
+oauth.delete
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/jbr/account.rb

@@ -0,0 +1,11 @@
+module Jbr
+  class Account < Resource
+    FIND = <<~GRAPHQL.freeze
+      { account { id } }
+    GRAPHQL
+
+    def id
+      @id ||= @oauth.query(FIND).dig 'account', 'id'
+    end
+  end
+end

data/lib/jbr/client.rb

@@ -0,0 +1,54 @@
+module Jbr
+  class Client < Resource
+    LOOKUP = <<~GRAPHQL.freeze
+      query($searchTerm: String!) {
+        clientPhones(searchTerm: $searchTerm) { nodes { client { id updatedAt } } }
+      }
+    GRAPHQL
+
+    CREATE = <<~GRAPHQL.freeze
+      mutation($input: ClientCreateInput!) {
+        clientCreate(input: $input) { client { id } userErrors { message } }
+      }
+    GRAPHQL
+
+    # Create a client instance with the provided attributes.
+    # @return [Client] itself
+    # @param params [Hash] the attributes of the client
+    # @option params [String] :first_name the client’s first name
+    # @option params [String] :last_name the client’s last name
+    # @option params [String] :phone the client’s phone number
+    # @option params [<String, nil>] :email the client’s email address
+    def create_with(params = {})
+      self.tap { @create_params = params }
+    end
+
+    def find_or_create_by(phone:)
+      find_by_phone(phone) || create
+      self
+    end
+
+  private
+
+    def find_by_phone(phone)
+      output = @oauth.query LOOKUP, variables: { searchTerm: phone }
+      recent = (output.dig('clientPhones', 'nodes') || []).max_by do |clients|
+        clients.dig('client', 'updatedAt') || ''
+      end
+      @id = recent&.dig 'client', 'id'
+    end
+
+    def create
+      output = @oauth.query CREATE, variables: { input: input }
+      @id = output.dig 'clientCreate', 'client', 'id'
+    end
+
+    def input
+      { firstName: @create_params[:first_name],
+        lastName: @create_params[:last_name],
+        phones: [{ number: @create_params[:phone], primary: true }],
+        emails: ([{ address: @create_params[:email], primary: true }] if @create_params[:email].present?)
+      }.compact
+    end
+  end
+end

data/lib/jbr/error.rb

@@ -0,0 +1,3 @@
+module Jbr
+  Error = Class.new StandardError
+end

data/lib/jbr/invoice.rb

@@ -0,0 +1,38 @@
+module Jbr
+  class Invoice < Resource
+    FIND = <<~GRAPHQL.freeze
+      query($id: EncodedId!) {
+        invoice(id: $id) { id total invoiceStatus issuedDate
+          jobs { nodes { id completedAt } } }
+      }
+    GRAPHQL
+
+    attr_reader :job_id, :total
+
+    def find(id)
+      output = @oauth.query FIND, variables: { id: id  }
+      return unless invoice = output['invoice']
+      return if invoice['invoiceStatus'].eql? 'draft'
+
+      @id = invoice['id']
+      @total = invoice['total']
+      @issued_date = invoice['issuedDate']
+
+      job = invoice.dig('jobs', 'nodes', 0) || {}
+      @job_id = job['id']
+      @completed_at = job['completedAt']
+
+      self
+    end
+
+    # @return [Date] the invoice issued date
+    def issued_date
+      Date.iso8601(@issued_date) if @issued_date
+    end
+
+    # @return [Time] the job completed time
+    def completed_at
+      Time.iso8601(@completed_at) if @completed_at
+    end
+  end
+end

data/lib/jbr/job.rb

@@ -0,0 +1,32 @@
+module Jbr
+  class Job < Resource
+    FIND = <<~GRAPHQL.freeze
+      query($id: EncodedId!) {
+        job(id: $id) { id quote { id } startAt completedAt }
+      }
+    GRAPHQL
+
+    attr_reader :quote_id
+
+    def find(id)
+      output = @oauth.query FIND, variables: { id: id  }
+      return unless job = output['job']
+
+      @id = job['id']
+      @quote_id = job.dig 'quote', 'id'
+      @scheduled_at = job['startAt']
+      @completed_at = job['completedAt']
+      self
+    end
+
+    # @return [Time] the job scheduled time
+    def scheduled_at
+      Time.iso8601(@scheduled_at) if @scheduled_at
+    end
+
+    # @return [Time] the job completed time
+    def completed_at
+      Time.iso8601(@completed_at) if @completed_at
+    end
+  end
+end

data/lib/jbr/oauth.rb

@@ -0,0 +1,84 @@
+module Jbr
+  class OAuth
+    DISCONNECT_MUTATION = <<~GRAPHQL.freeze
+      mutation Disconnect {
+        appDisconnect {
+          app { name author }
+          userErrors { message }
+        }
+      }
+    GRAPHQL
+
+    def initialize(credentials = {})
+      @access_token = credentials[:access_token]
+      @refresh_token = credentials[:refresh_token]
+      @expires_at = credentials[:expires_at]
+      @account_id = credentials[:account_id]
+      @invalid_at = credentials[:invalid_at]
+    end
+
+    attr_reader :access_token, :refresh_token, :expires_at, :invalid_at
+    attr_accessor :account_id
+
+    def account = Account.new oauth: self
+    def clients = Client.new oauth: self
+    def invoices = Invoice.new oauth: self
+    def jobs = Job.new oauth: self
+    def quotes = Quote.new oauth: self
+    def requests = Request.new oauth: self
+
+    def query(statement, variables: {})
+      client.query statement, variables: variables
+    rescue GraphQL::Unauthorized => e
+      refresh ? retry : {}
+    end
+
+    # Delete a token. If the token is invalid, do nothing.
+    def delete
+      client.query DISCONNECT_MUTATION
+    rescue GraphQL::Unauthorized => e
+    end
+
+    def self.create(code:, redirect_uri:)
+      credentials = post code: code, redirect_uri: redirect_uri, grant_type: 'authorization_code'
+      new(credentials).tap { |oauth| oauth.account_id = oauth.account.id }
+    end
+
+  private
+
+    def refresh
+      output = self.class.post refresh_token: @refresh_token, grant_type: 'refresh_token'
+      @access_token = output[:access_token]
+      @refresh_token = output[:refresh_token]
+      @expires_at = output[:expires_at]
+    rescue Error => e
+      @invalid_at = Time.current
+      false
+    end
+
+    def self.post(params = {})
+      uri = URI 'https://api.getjobber.com/api/oauth/token'
+      response = Net::HTTP.post_form uri, params.merge(client_id: client_id, client_secret: client_secret)
+      raise Error, response.body unless response.is_a? Net::HTTPSuccess
+      output = JSON.parse(response.body)
+      { access_token: output['access_token'], refresh_token: output['refresh_token'],
+        expires_at: (Time.current + output.fetch('expires_in', 3600).to_i) }
+    end
+
+    def self.client_id = ENV['JOBBER_CLIENT_ID']
+
+    def self.client_secret = ENV['JOBBER_CLIENT_SECRET']
+
+    def client
+      GraphQL::Client.new endpoint: 'https://api.getjobber.com/api/graphql', token: @access_token, headers: headers
+    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/quote.rb

@@ -0,0 +1,20 @@
+module Jbr
+  class Quote < Resource
+    FIND = <<~GRAPHQL.freeze
+      query($id: EncodedId!) {
+        quote(id: $id) { id request { id } }
+      }
+    GRAPHQL
+
+    attr_reader :request_id
+
+    def find(id)
+      output = @oauth.query FIND, variables: { id: id  }
+      return unless quote = output['quote']
+
+      @id = quote['id']
+      @request_id = quote.dig 'request', 'id'
+      self
+    end
+  end
+end

data/lib/jbr/request.rb

@@ -0,0 +1,28 @@
+module Jbr
+  class Request < Resource
+    CREATE = <<~GRAPHQL.freeze
+      mutation($input: RequestCreateInput!) {
+        requestCreate(input: $input) { request { id } userErrors { message } }
+      }
+    GRAPHQL
+
+    attr_reader :client_id
+
+    # Create a lead in Jobber associated to a new or existing client, matched by phone.
+    # @return [String] the ID of the newly created lead.
+    # @param params [Hash] the attributes of the lead
+    # @option params [String] :first_name the client’s first name
+    # @option params [String] :last_name the client’s last name
+    # @option params [String] :phone the client’s phone number
+    # @option params [<String, nil>] :email the client’s email address
+    # @option params [String] :title the reason why the lead is created
+    # @option params [String] :instructions a comment about the lead
+    def create(params = {})
+      @client_id = @oauth.clients.create_with(params).find_or_create_by(phone: params[:phone]).id
+      input = { clientId: @client_id, title: params[:title], assessment: { instructions: params[:instructions] } }
+      output = @oauth.query CREATE, variables: { input: input }
+      @id = output.dig 'requestCreate', 'request', 'id'
+      self
+    end
+  end
+end

data/lib/jbr/resource.rb

@@ -0,0 +1,9 @@
+module Jbr
+  class Resource
+    def initialize(oauth:)
+      @oauth = oauth
+    end
+
+    attr_reader :id
+  end
+end

data/lib/jbr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jbr
-  VERSION = "0.1.0"
+  VERSION = '1.0.2'
 end

data/lib/jbr.rb

@@ -1,8 +1,15 @@
 # frozen_string_literal: true
 
-require_relative "jbr/version"
+require 'json'
+require 'net/http'
 
-module Jbr
-  class Error < StandardError; end
-  # Your code goes here...
-end
+require 'jbr/error'
+require 'jbr/resource'
+require 'jbr/request'
+require 'jbr/oauth'
+
+require 'jbr/account'
+require 'jbr/client'
+require 'jbr/invoice'
+require 'jbr/job'
+require 'jbr/quote'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jbr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.2
 platform: ruby
 authors:
-- claudiob
+- Claudio Baccigalupo
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: The Jobber API Ruby client
+description: Jobber API
 email:
 - claudiob@users.noreply.github.com
 executables: []
@@ -19,17 +19,24 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/jbr.rb
+- lib/jbr/account.rb
+- lib/jbr/client.rb
+- lib/jbr/error.rb
+- lib/jbr/invoice.rb
+- lib/jbr/job.rb
+- lib/jbr/oauth.rb
+- lib/jbr/quote.rb
+- lib/jbr/request.rb
+- lib/jbr/resource.rb
 - lib/jbr/version.rb
-- sig/jbr.rbs
-homepage: https://example.com
+homepage: https://github.com/HouseAccountEng/jbr
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://example.com
-  source_code_uri: https://example.com
-  changelog_uri: https://example.com
+  homepage_uri: https://github.com/HouseAccountEng/jbr
+  source_code_uri: https://github.com/HouseAccountEng/jbr
+  changelog_uri: https://github.com/HouseAccountEng/jbr
 rdoc_options: []
 require_paths:
 - lib
@@ -46,5 +53,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.3
 specification_version: 4
-summary: The Jobber API Ruby client
+summary: A Ruby client for the Jobber API.
 test_files: []

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/sig/jbr.rbs

@@ -1,4 +0,0 @@
-module Jbr
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end