faxplus_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9cff90ca10e3d920252b321f3aa2fc7efeeece3334b095a52a4c46c5260d5dba
+  data.tar.gz: 5c60b71ccacb08b06425dbfa5e4860a506a93b80ee7945d193b01ef3a52c643e
+SHA512:
+  metadata.gz: 8cdb47c45c58ab5c4a5a628bc5bbf8033c155b66f044852ee02a5d7c8826143d603aaef4a37dd54a1be027141c868f06a4073f064a88eac0008b484c698771c2
+  data.tar.gz: 02fcc04c4e6d676080b464d2bbaa6d1e7826f02111be7aed005a8cd33778eca08e2e463e7509a8a85f40dd9759763fbb71a70c8c16d793d7b80c0fafa263c831

data/README.md

@@ -0,0 +1,72 @@
+# FaxPlus
+
+Faxplus is a Ruby library for interacting with faxplus APIs.
+
+## Setting things up.
+To start using faxplus, you first need to add it to your Gemfile, with an entry such as this:
+
+```ruby
+gem 'faxplus_ruby'
+```
+
+Afterwards, run `bundle install` 
+
+Next, you'll need to create a PAT token from faxplus dashboard here is the link [https://apidoc.fax.plus/v3/?shell#option-1-personal-access-tokens-pats
+
+## Accounts.
+
+```ruby
+client = FaxplusApi::Client.new(access_token: ENV['FAXPLUS_PAT_TOKEN'])
+client.account.accounts # List corporate members
+client.account.user(user_id: 'userid') # Get account information
+client.account.update_user(user_id: 'userid') # Modify account information
+client.account.member(member_user_id: 'member_user_id') # Get member details
+client.account.update_member(member_user_id: 'member_user_id') # Modify member details
+```
+
+## Numbers.
+
+```ruby
+client.number.list(user_id: 'userid') # List phone numbers
+client.number.get(user_id: 'userid', number: 'number') # Get number information
+client.number.update(user_id: 'userid', number: 'number') # Assign number
+client.number.revoke(user_id: 'userid', number: 'number') # Revoke number
+```
+## Faxes.
+
+```ruby
+client.fax.list(user_id: 'userid') # List fax records
+client.fax.get(user_id: 'userid', fax_id: 'fax_id') # Get a fax record
+client.fax.update(user_id: 'userid', fax_id: 'fax_id') # Modify fax record
+client.fax.revoke(user_id: 'userid', fax_id: 'fax_id') # Delete a fax
+```
+## Files.
+
+```ruby
+client.file.upload(user_id: 'userid') # Upload a file TODO: Need proper params how to send file
+client.file.get(user_id: 'userid', fax_id: 'fax_id') # Download fax file
+client.file.fax_report(user_id: 'userid', fax_id: 'fax_id') # Get fax confirmation report
+```
+## Outbox.
+
+```ruby
+client.outbox.list(user_id: 'userid') # List faxes in the outbox
+# TODO: require proper params here
+client.outbox.send(user_id: 'userid') # Send a fax 
+client.outbox.get(user_id: 'userid', outbox_fax_id: 'outbox_fax_id') # List outgoing faxes
+client.outbox.update(user_id: 'userid', outbox_fax_id: 'outbox_fax_id') # Delete an outgoing fax
+client.outbox.delete(user_id: 'userid', outbox_fax_id: 'outbox_fax_id') # Modify an outgoing fax
+```
+## Webhooks.
+
+```ruby
+client.webhook.list # List user webhooks
+client.webhook.create # Register new webhook
+client.webhook.delete(hook_id: 'hook_id') # Delete webhook
+```
+
+## Testing
+TODO
+
+## More help
+Please submit an issue via GitHub if you need more help with the faxplus_ruby gem.

data/lib/faxplus_api/account.rb

@@ -0,0 +1,29 @@
+require_relative "base"
+
+module FaxplusApi
+  class Account < Base
+    def accounts(url: "#{@base_url}/accounts", data: {})
+      make_request(url: url, data: data)
+    end
+
+    def user(url: "#{@base_url}/accounts/%{user_id}", user_id:, data: {})
+      url = url % {user_id: user_id}
+      make_request(url: url, data: data)
+    end
+
+    def update_user(url: "#{@base_url}/accounts/%{user_id}", user_id:, data: {})
+      url = url % {user_id: user_id}
+      make_request(url: url, data: data, method: 'put')
+    end
+
+    def member(url: "#{@base_url}/accounts/self/member-details/%{member_user_id}", member_user_id:, data: {})
+      url = url % {member_user_id: member_user_id}
+      make_request(url: url, data: data)
+    end
+
+    def update_member(url: "#{@base_url}/accounts/self/member-details/%{member_user_id}", member_user_id:, data: {})
+      url = url % {member_user_id: member_user_id}
+      make_request(url: url, data: data, method: 'put')
+    end
+  end
+end

data/lib/faxplus_api/base.rb

@@ -0,0 +1,42 @@
+require 'rest-client'
+require 'json'
+
+module FaxplusApi
+  class Base
+    def initialize(client)
+      @client = client
+      @access_token = client.access_token
+      @base_url = client.base_url
+    end
+
+    def make_request(url: , data: , method: 'get')
+      begin
+        response =  if method == 'post'
+                      RestClient.post(url, data.to_json, headers)
+                    elsif method == 'put'
+                      RestClient.put(url, data.to_json, headers)
+                    elsif method == 'get'
+                      RestClient.get(url, headers)
+                    elsif method == 'delete'
+                      RestClient.delete(url, headers)
+                    end
+      rescue RestClient::ExceptionWithResponse => e
+        return { error: e.response.body }
+      end
+
+      return response.body if response.body.nil?
+
+      JSON.parse(response.body, symbolize_names: true) rescue response.body
+    end
+
+    private
+
+      def headers
+        {
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json',
+          'Authorization' => "Bearer #{@access_token}"
+        }
+      end
+  end
+end

data/lib/faxplus_api/client.rb

@@ -0,0 +1,44 @@
+require_relative "account"
+require_relative "file"
+require_relative "fax"
+require_relative "outbox"
+require_relative "number"
+require_relative "webhook"
+
+BASE_URL = "https://restapi.fax.plus/v3"
+
+module FaxplusApi
+  class Client
+
+    attr_reader :access_token, :base_url
+
+    def initialize(access_token: ENV['FAXPLUS_PAT_TOKEN'])
+      @access_token = access_token
+      @base_url = BASE_URL
+    end
+
+    def file(params = {})
+      @file ||= File.new(self)
+    end
+
+    def account(params = {})
+      @account ||= Account.new(self)
+    end
+
+    def fax(params = {})
+      @fax ||= Fax.new(self)
+    end
+
+    def number(params = {})
+      @number ||= Number.new(self)
+    end
+
+    def outbox(params = {})
+      @outbox ||= Outbox.new(self)
+    end
+
+    def webhook(params = {})
+      @webhook ||= Webhook.new(self)
+    end
+  end
+end

data/lib/faxplus_api/fax.rb

@@ -0,0 +1,25 @@
+require_relative "base"
+
+module FaxplusApi
+  class Fax < Base
+    def list(url: "#{@base_url}/accounts/%{user_id}/faxes", user_id:, data: {})
+      url = url % {user_id: user_id}
+      make_request(url: url, data: data)
+    end
+
+    def get(url: "#{@base_url}/accounts/%{user_id}/faxes/%{fax_id}", fax_id:, user_id:, data: {})
+      url = url % {user_id: user_id, fax_id: fax_id}
+      make_request(url: url, data: data)
+    end
+
+    def update(url: "#{@base_url}/accounts/%{user_id}/faxes/%{fax_id}", fax_id:, user_id:, data: {})
+      url = url % {user_id: user_id, fax_id: fax_id}
+      make_request(url: url, data: data, method: 'put')
+    end
+
+    def delete(url: "#{@base_url}/accounts/%{user_id}/faxes/%{fax_id}", fax_id:, user_id:, data: {})
+      url = url % {user_id: user_id, fax_id: fax_id}
+      make_request(url: url, data: data, method: 'delete')
+    end
+  end
+end

data/lib/faxplus_api/file.rb

@@ -0,0 +1,20 @@
+require_relative "base"
+
+module FaxplusApi
+  class File < Base
+    def upload(url: "#{@base_url}/accounts/%{user_id}/files", user_id:, data: {})
+      url = url % {user_id: user_id}
+      make_request(url: url, data: data, method: 'post')
+    end
+
+    def get(url: "#{@base_url}/accounts/%{user_id}/files/%{fax_id}", user_id:, fax_id:, data: {})
+      url = url % {user_id: user_id, fax_id: fax_id}
+      make_request(url: url, data: data)
+    end
+
+    def fax_report(url: "#{@base_url}/accounts/%{user_id}/report/%{fax_id}", user_id:, fax_id:, data: {})
+      url = url % {user_id: user_id, fax_id: fax_id}
+      make_request(url: url, data: data)
+    end
+  end
+end

data/lib/faxplus_api/number.rb

@@ -0,0 +1,25 @@
+require_relative "base"
+
+module FaxplusApi
+  class Number < Base
+    def list(url: "#{@base_url}/accounts/%{user_id}/numbers", user_id:, data: {})
+      url = url % {user_id: user_id}
+      make_request(url: url, data: data)
+    end
+
+    def get(url: "#{@base_url}/accounts/%{user_id}/numbers/%{number}", user_id:, number:, data: {})
+      url = url % {user_id: user_id, number: number}
+      make_request(url: url, data: data)
+    end
+
+    def update(url: "#{@base_url}/accounts/%{user_id}/numbers/%{number}", user_id:, number:, data: {})
+      url = url % {user_id: user_id, number: number}
+      make_request(url: url, data: data, method: 'put')
+    end
+
+    def revoke(url: "#{@base_url}/accounts/%{user_id}/numbers/%{number}", user_id:, number:, data: {})
+      url = url % {user_id: user_id, number: number}
+      make_request(url: url, data: data, method: 'delete')
+    end
+  end
+end

data/lib/faxplus_api/outbox.rb

@@ -0,0 +1,30 @@
+require_relative "base"
+
+module FaxplusApi
+  class Outbox < Base
+    def list(url: "#{@base_url}/accounts/%{user_id}/outbox", user_id:, data: {})
+      url = url % {user_id: user_id}
+      make_request(url: url, data: data)
+    end
+
+    def send(url: "#{@base_url}/accounts/%{user_id}/outbox", user_id:, data: {})
+      url = url % {user_id: user_id, fax_id: fax_id}
+      make_request(url: url, data: data, method: 'post')
+    end
+
+    def get(url: "#{@base_url}/accounts/%{user_id}/outbox/%{outbox_fax_id}", outbox_fax_id:, user_id:, data: {})
+      url = url % {user_id: user_id, outbox_fax_id: outbox_fax_id}
+      make_request(url: url, data: data)
+    end
+
+    def update(url: "#{@base_url}/accounts/%{user_id}/outbox/%{outbox_fax_id}", outbox_fax_id:, user_id:, data: {})
+      url = url % {user_id: user_id, outbox_fax_id: outbox_fax_id}
+      make_request(url: url, data: data, method: 'put')
+    end
+
+    def delete(url: "#{@base_url}/accounts/%{user_id}/outbox/%{outbox_fax_id}", outbox_fax_id:, user_id:, data: {})
+      url = url % {user_id: user_id, outbox_fax_id: outbox_fax_id}
+      make_request(url: url, data: data, method: 'delete')
+    end
+  end
+end

data/lib/faxplus_api/version.rb

@@ -0,0 +1,3 @@
+module FaxplusApi
+  VERSION = "0.0.1"
+end

data/lib/faxplus_api/webhook.rb

@@ -0,0 +1,18 @@
+require_relative "base"
+
+module FaxplusApi
+  class Webhook < Base
+    def list(url: "#{@base_url}/hooks", data: {})
+      make_request(url: url, data: data)
+    end
+
+    def create(url: "#{@base_url}/hooks", data: {})
+      make_request(url: url, data: data, method: 'post')
+    end
+
+    def delete(url: "#{@base_url}/hooks/%{hook_id}", hook_id:, data: {})
+      url = url % {hook_id: hook_id}
+      make_request(url: url, data: data, method: 'delete')
+    end
+  end
+end

data/lib/faxplus_api.rb

@@ -0,0 +1,9 @@
+require_relative "faxplus_api/version"
+require_relative "faxplus_api/client"
+require_relative "faxplus_api/base"
+require_relative "faxplus_api/account"
+require_relative "faxplus_api/file"
+require_relative "faxplus_api/fax"
+require_relative "faxplus_api/outbox"
+require_relative "faxplus_api/number"
+require_relative "faxplus_api/webhook"

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: faxplus_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dilkhush Soni
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: 
+email:
+- dilkhushsoni2010@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/faxplus_api.rb
+- lib/faxplus_api/account.rb
+- lib/faxplus_api/base.rb
+- lib/faxplus_api/client.rb
+- lib/faxplus_api/fax.rb
+- lib/faxplus_api/file.rb
+- lib/faxplus_api/number.rb
+- lib/faxplus_api/outbox.rb
+- lib/faxplus_api/version.rb
+- lib/faxplus_api/webhook.rb
+homepage: https://github.com/dilkhush/faxplus-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A simple wrapper around ifaxapp's API
+test_files: []