faxplus_api 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 798fb5fe6c1a20d813f70a36f5536faf816681dddd42ad51483b1dab2fa10b84
-  data.tar.gz: 11a8889f8315641cc7beb609b4b71386703dcc7b391e45508c1699bccba0defd
+  metadata.gz: 4d7d5d99a832e5707096a02ae5209ea2984306a74d964345143acf573616fd9a
+  data.tar.gz: a049ba2bd56c73f3bdb6753a75cf73642128a916c750cc5519631e58bc5ee834
 SHA512:
-  metadata.gz: 77d1fb41d4ca7cf0e7b86fe04b5c1d7c5b2ec4dd08efd519fd4e557e955217a8385a3e901f2cc87da797ab54a2b4b686ba39b262a243aa367963cf3b9064d57e
-  data.tar.gz: a72a743da2f10cc80191f751869e534c025600e8aa897706ba04d2164d9ba5e7b1dda3659bff1d2fa031e61483a24763153b47a11af5c9a5b5cfd2ee7b3f2737
+  metadata.gz: 4a4c22a9b6bfd8a1f0d1afa06202c65ebf04739ca43fe860047a29278641ad17c42579c6a850a151e1fcefcea045926586852199e815d432355e9f388d1e7b0f
+  data.tar.gz: 9f7e41ed1231cd4bd97d8a465fe670dd8062c6659695b5842c01fe251f96e2248ec2ed8df581b47f76b730101b47154bb264e533c7a465d7d7126c51a7399d7f

data/README.md

@@ -6,7 +6,7 @@ Faxplus is a Ruby library for interacting with faxplus APIs.
 To start using faxplus, you first need to add it to your Gemfile, with an entry such as this:
 
 ```ruby
-gem 'faxplus_ruby'
+gem 'faxplus_api'
 ```
 
 Afterwards, run `bundle install` 
@@ -43,7 +43,8 @@ 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
+# Upload a file
+client.file.upload(user_id: 'userid', data: {fax_file: File.open('pdf_file_path.pdf'), multipart: true}) => {:path => "/storage/transient-hsfhadhaskha.pdf"}
 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
 ```
@@ -51,8 +52,8 @@ client.file.fax_report(user_id: 'userid', fax_id: 'fax_id') # Get fax confirmati
 
 ```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 
+# file_path from the client.file.upload output path
+client.outbox.send(user_id: 'userid', data: {from: "+12345667", to: ["+12345688"], files: [file_path]}) # 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

data/lib/faxplus_api/base.rb

@@ -9,16 +9,16 @@ module FaxplusApi
       @base_url = client.base_url
     end
 
-    def make_request(url: , data: , method: 'get')
+    def make_request(url:, data:, method: 'get', content_type: 'application/json')
       begin
         response =  if method == 'post'
-                      RestClient.post(url, data.to_json, headers)
+                      RestClient.post(url, data, headers(content_type))
                     elsif method == 'put'
-                      RestClient.put(url, data.to_json, headers)
+                      RestClient.put(url, data, headers(content_type))
                     elsif method == 'get'
-                      RestClient.get(url, headers)
+                      RestClient.get(url, headers(content_type))
                     elsif method == 'delete'
-                      RestClient.delete(url, headers)
+                      RestClient.delete(url, headers(content_type))
                     end
       rescue RestClient::ExceptionWithResponse => e
         return { error: e.response.body }
@@ -31,9 +31,9 @@ module FaxplusApi
 
     private
 
-      def headers
+      def headers(content_type)
         {
-          'Content-Type' => 'application/json',
+          'Content-Type' => content_type,
           'Accept' => 'application/json',
           'Authorization' => "Bearer #{@access_token}"
         }

data/lib/faxplus_api/file.rb

@@ -4,7 +4,7 @@ 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')
+      make_request(url: url, data: data, method: 'post', content_type: 'multipart/form-data')
     end
 
     def get(url: "#{@base_url}/accounts/%{user_id}/files/%{fax_id}", user_id:, fax_id:, data: {})

data/lib/faxplus_api/outbox.rb

@@ -8,7 +8,7 @@ module FaxplusApi
     end
 
     def send(url: "#{@base_url}/accounts/%{user_id}/outbox", user_id:, data: {})
-      url = url % {user_id: user_id, fax_id: fax_id}
+      url = url % {user_id: user_id}
       make_request(url: url, data: data, method: 'post')
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faxplus_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Dilkhush Soni
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-20 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,15 +44,17 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.8.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
-description: 
+        version: 1.8.6
+description: |2
+    A simple wrapper around faxplus's API.
+    For detailed documentation, please visit: https://github.com/dilkhush/faxplus-ruby/blob/main/README.md
 email:
 - dilkhushsoni2010@gmail.com
 executables: []
@@ -89,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A simple wrapper around faxplus's API