omniauth-free_agent 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2de9b0bb2edbafa6a2b98f366649399763a6f2a7cedc1aadd499649682a25ef
-  data.tar.gz: 131f6afb6ac186cdba094345b4e0d4c20390bb7fc32c4181c044cc22fe2c3a02
+  metadata.gz: 000aa87be94113e3bb658048acec7ad00a95388e425537ac759dd26204ec3b94
+  data.tar.gz: e016d5c740beb7a3847a6d79f5f911f4ac0f70e24ff59c61398e012454e8f67f
 SHA512:
-  metadata.gz: 3d901338ebaf1338fe171b84e88fe8d71138285ba2ae9fc7a5c8e8ffc54fe94a21c25c436773ac361e11358feca6ecf65e5b0edc55b977edc654c7e8948fbd8a
-  data.tar.gz: 98d6cbe5f4937e3b881b12c47db363f08f1dc5c3514e774f4b37dc6a5aab87d6e3a922127a8192586656c782f006234cedf725c8c76a6037665e8fc2573c245f
+  metadata.gz: b271d408c76f8a62440f81ddaab3cfe8dab4932e5b892dbb13dfd4061141459862a7f69b5b87af68e814f4ccdc1df1922a202794b564c85bfad9890fb31aea2e
+  data.tar.gz: c1724133915a477c7f5c1f898064d97e64ba9eac55080848d52327c6e185296ae976070e7be650f280fff4d5d1d1f1253fa2db52bbded522bc5593ca4f15f8f9

data/README.md

@@ -1,29 +1,115 @@
-# Omniauth::Oauth2::Freeagent
+# OmniAuth FreeAgent
 
-TODO: Delete this and the text below, and describe your gem
+An OmniAuth strategy for FreeAgent
 
 ## 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.
+Add the OmniAuth FreeAgent and OmniAuth rails_csrf_protection gems to your Gemfile
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+gem 'omniauth-free_agent'
+gem 'omniauth-rails_csrf_protection'
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Usage
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+You can create an application on the [FreeAgent Developer Dashboard](https://dev.freeagent.com/) and get your app and secret keys.
 
-## Usage
+Here's an example for adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
 
-TODO: Write usage instructions here
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :free_agent, ENV["FREEAGENT_CLIENT"], ENV["FREEAGENT_SECRET"]
+end
+```
 
-## Development
+Or for the FreeAgent Sandbox:
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :free_agent_sandbox, ENV["FREEAGENT_CLIENT"], ENV["FREEAGENT_SECRET"]
+end
+```
 
-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).
+## Auth Hash
 
-## Contributing
+Here's an example Auth hash available in `request.env["omniauth.auth"]`:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniauth-oauth2-freeagent.
+```json
+{
+  "provider": "free_agent_sandbox",
+  "uid": "https://api.sandbox.freeagent.com/v2/users/ID",
+  "info": {
+    "email": "test@test.com",
+    "first_name": "Test",
+    "last_name": "User",
+    "name": "Test User"
+  },
+  "credentials": {
+    "token": "abc123",
+    "refresh_token": "123abc",
+    "expires_at": 123123123,
+    "expires": true
+  },
+  "extra": {
+    "user": {
+      "url": "https://api.sandbox.freeagent.com/v2/users/ID",
+      "first_name": "Test",
+      "last_name": "User",
+      "hidden": false,
+      "email": "test@test.com",
+      "role": "Owner",
+      "permission_level": 8,
+      "opening_mileage": "0.0",
+      "updated_at": "2024-08-12T14:15:01.000Z",
+      "created_at": "2024-08-12T14:09:02.000Z"
+    },
+    "company": {
+      "company": {
+        "url": "https://api.sandbox.freeagent.com/v2/company",
+        "id": 22954,
+        "name": "My Company",
+        "subdomain": "mycompany",
+        "type": "UkSoleTrader",
+        "company_start_date": "2024-04-06",
+        "currency": "GBP",
+        "mileage_units": "miles",
+        "short_date_format": "dd mmm yy",
+        "freeagent_start_date": "2024-04-06",
+        "first_accounting_year_end": "2025-04-05",
+        "annual_accounting_periods": [
+          {
+            "starts_on": "2024-04-06",
+            "ends_on": "2025-04-05"
+          }
+        ],
+        "address1": "1 A Road",
+        "town": "2 A Town",
+        "postcode": "AA11 1AA",
+        "country": "United Kingdom",
+        "locale": "en",
+        "business_category": "Software Development",
+        "cis_enabled": false,
+        "locked_attributes": [
+          "currency"
+        ],
+        "created_at": "2024-08-12T14:09:02.000Z",
+        "updated_at": "2024-08-12T14:09:46.000Z",
+        "sales_tax_registration_status": "Not Registered",
+        "ec_vat_reporting_enabled": false,
+        "sales_tax_name": "VAT",
+        "sales_tax_effective_date": "2024-04-06",
+        "sales_tax_rates": [
+          "20.0",
+          "5.0",
+          "0.0"
+        ],
+        "supports_auto_sales_tax_on_purchases": true,
+        "initially_on_frs": false,
+        "sales_tax_is_value_added": true,
+        "initial_vat_basis": "Invoice"
+      }
+    }
+  }
+}
+```

data/lib/omniauth/free_agent/version.rb

@@ -2,6 +2,6 @@
 
 module Omniauth
   module FreeAgent
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/omniauth/free_agent.rb

@@ -1,10 +1,3 @@
-# frozen_string_literal: true
-
 require_relative "free_agent/version"
-
-module Omniauth
-  module FreeAgent
-    class Error < StandardError; end
-    # Your code goes here...
-  end
-end
+require "omniauth/strategies/free_agent"
+require "omniauth/strategies/free_agent_sandbox"

data/lib/omniauth/strategies/free_agent.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "omniauth/strategies/oauth2"
+
+module OmniAuth
+  module Strategies
+    class FreeAgent < OmniAuth::Strategies::OAuth2
+      option :name, "free_agent"
+
+      option :client_options, {
+        site: "https://api.freeagent.com",
+        authorize_url: "https://api.freeagent.com/v2/approve_app",
+        token_url: "https://api.freeagent.com/v2/token_endpoint",
+      }
+
+      uid do
+        user_info["url"]
+      end
+
+      info do
+        {
+          email: user_info["email"],
+          first_name: user_info["first_name"],
+          last_name: user_info["last_name"],
+        }
+      end
+
+      extra do
+        {
+          user: user_info,
+          company: company_info
+        }
+      end
+
+      def user_info
+        @user_info ||= access_token.get("/v2/users/me").parsed["user"]
+      end
+
+      def company_info
+        @company_info ||= access_token.get("/v2/company").parsed
+      end
+
+      def callback_url
+        options[:redirect_uri] || full_host + script_name + callback_path
+      end
+    end
+  end
+end
+
+# OmniAuth.config.add_camelization "freeagent", "FreeAgent"

data/lib/omniauth/strategies/free_agent_sandbox.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "omniauth/strategies/oauth2"
+
+module OmniAuth
+  module Strategies
+    class FreeAgentSandbox < OmniAuth::Strategies::FreeAgent
+
+      option :name, "free_agent_sandbox"
+
+      option :client_options, {
+        site: "https://api.sandbox.freeagent.com",
+        authorize_url: "https://api.sandbox.freeagent.com/v2/approve_app",
+        token_url: "https://api.sandbox.freeagent.com/v2/token_endpoint",
+      }
+
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-free_agent
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dean Perry
@@ -49,6 +49,8 @@ files:
 - Rakefile
 - lib/omniauth/free_agent.rb
 - lib/omniauth/free_agent/version.rb
+- lib/omniauth/strategies/free_agent.rb
+- lib/omniauth/strategies/free_agent_sandbox.rb
 homepage: https://github.com/deanpcmad/omniauth-free_agent
 licenses: []
 metadata: