ruby-magicwrite 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7196a229f9665af5e45c3c039aff8aed41a4ae495a1ec90ef882f7f2f025858
-  data.tar.gz: bcbc8eac9a03a650b7ac39da3aaab4715a78b0d895cd583565bc703ee8262c57
+  metadata.gz: fe492bf84e88d0fac86ee681671ab724a7247d37403301fcc6b2d24c5db23fb0
+  data.tar.gz: 67460bd0593a9e4b7503e6e048b42d0927631c62e784951056d629edc1e99666
 SHA512:
-  metadata.gz: 92e2cc734dfd82bbf196b8dff81873dc516706b2fb4e9889f3a7c8d5360153c21226c5f1f4dbcfd6d1616b7a7a5518886d3894f74ff574bc7ad78dca17db9e13
-  data.tar.gz: 3895dfe940935bd163ebb0e60b57209f074ebbb1c6bcd898aad98f1f7a38df32e7acfdd61c0233c4741e55b62fb653728ac196e0af6e30b7adcf356507564217
+  metadata.gz: d6a1b30d5c33d06fcd20eb1ce55e76326fc3889852824b331cc4da7ba8f2a65f1186cdbf44aff6180ba66afc6c2695a329d45ae2dc8edd85f1d141e3ec5f14a1
+  data.tar.gz: 564f7069e45f14f0370c634c65296d915032e9ac1a6c393724ef1aaa97187c85b222680ff6ab4a1909a0a7fd0753fe571114c0e0c4fb8f378f5c2d310d350b21

data/CHANGELOG.md

@@ -5,6 +5,34 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.5] - 2023-08-22
+
+### Added
+
+- More specs to cover more implementations
+- Refactor client and methods to use client in initalization
+- include HTTP instead of extend for Client class
+
+## [0.1.4] - 2023-08-22
+
+### Added
+
+- Memberships endpoints to MagicWrite client
+
+
+## [0.1.3] - 2023-08-21
+
+### Added
+
+- General error classes by HTTP responses
+- Error handler to parse the result
+
+
+### Changed
+
+- README
+
+
 ## [0.1.2] - 2023-06-21
 
 ### Added
@@ -24,6 +52,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Initialise repository.
+- Initialize repository.
 - Add MagicWrite::Client to connect to MagicWrite API using user tokens.
+  * Completions
+  * Agents
+  * Companies
+  * Ingestions
+  * Session
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-magicwrite (0.1.3)
+    ruby-magicwrite (0.1.5)
       faraday (>= 1)
       faraday-multipart (>= 1)
 

data/README.md

@@ -12,13 +12,17 @@ gem "ruby-magicwrite"
 
 And then execute:
 
+```bash
 $ bundle install
+```
 
 ### Gem install
 
 Or install with:
 
-$ gem install ruby-magicwrite
+```bash
+$ gem install ruby-openai
+```
 
 and require with:
 

data/lib/magicwrite/agents.rb

@@ -1,39 +1,43 @@
 module MagicWrite
   class Agents
-    def initialize(access_token: nil)
-      MagicWrite.configuration.access_token = access_token if access_token
+    def initialize(client:)
+      @client = client
     end
 
     def list(parameters: {})
-      MagicWrite::Client.get(path: '/agents', parameters: parameters)
+      client.get(path: '/agents', parameters: parameters)
     end
 
     def create(parameters: {})
-      MagicWrite::Client.json_post(path: '/agents', parameters: parameters)
+      client.json_post(path: '/agents', parameters: parameters)
     end
 
     def retrieve(id:)
-      MagicWrite::Client.get(path: "/agents/#{id}")
+      client.get(path: "/agents/#{id}")
     end
 
     def update(id:, parameters: {})
-      MagicWrite::Client.json_put(path: "/agents/#{id}", parameters: parameters)
+      client.json_put(path: "/agents/#{id}", parameters: parameters)
     end
 
     def delete(id:)
-      MagicWrite::Client.delete(path: "/agents/#{id}")
+      client.delete(path: "/agents/#{id}")
     end
 
     def public_list(company_id:, parameters: {})
-      MagicWrite::Client.get(path: "/agents/#{company_id}", parameters: parameters)
+      client.get(path: "/agents/#{company_id}", parameters: parameters)
     end
 
     def public_retrieve(company_id:, agent_id:)
-      MagicWrite::Client.get(path: "/agents/#{company_id}/#{agent_id}")
+      client.get(path: "/agents/#{company_id}/#{agent_id}")
     end
 
     def public_create(company_id:, agent_id:, parameters: {})
-      MagicWrite::Client.json_post(path: "/agents/#{company_id}/#{agent_id}", parameters: parameters)
+      client.json_post(path: "/agents/#{company_id}/#{agent_id}", parameters: parameters)
     end
+
+    private
+
+    attr_reader :client
   end
 end

data/lib/magicwrite/client.rb

@@ -1,31 +1,43 @@
 module MagicWrite
   class Client
-    extend MagicWrite::HTTP
+    include MagicWrite::HTTP
 
-    def initialize(access_token: nil, uri_base: nil, request_timeout: nil)
-      MagicWrite.configuration.access_token = access_token if access_token
-      MagicWrite.configuration.uri_base = uri_base if uri_base
-      MagicWrite.configuration.request_timeout = request_timeout if request_timeout
+    CONFIG_KEYS = %i[
+      access_token
+      uri_base
+      request_timeout
+      extra_headers
+    ].freeze
+    attr_reader(*CONFIG_KEYS)
+
+    def initialize(config = {})
+      CONFIG_KEYS.each do |key|
+        instance_variable_set("@#{key}", config[key] || MagicWrite.configuration.send(key))
+      end
     end
 
     def agents
-      @agents ||= MagicWrite::Agents.new
+      @agents ||= MagicWrite::Agents.new(client: self)
     end
 
     def companies
-      @companies ||= MagicWrite::Companies.new
+      @companies ||= MagicWrite::Companies.new(client: self)
     end
 
     def completions
-      @completions ||= MagicWrite::Completions.new
+      @completions ||= MagicWrite::Completions.new(client: self)
     end
 
     def ingestions
-      @ingestions ||= MagicWrite::Ingestions.new
+      @ingestions ||= MagicWrite::Ingestions.new(client: self)
+    end
+
+    def memberships
+      @memberships ||= MagicWrite::Memberships.new(client: self)
     end
 
     def session
-      MagicWrite::Client.get(path: '/session')
+      get(path: '/session')
     end
   end
 end

data/lib/magicwrite/companies.rb

@@ -1,19 +1,23 @@
 module MagicWrite
   class Companies
-    def initialize(access_token: nil)
-      MagicWrite.configuration.access_token = access_token if access_token
+    def initialize(client:)
+      @client = client
     end
 
     def create(parameters: {})
-      MagicWrite::Client.json_post(path: '/companies', parameters: parameters)
+      client.json_post(path: '/companies', parameters: parameters)
     end
 
     def retrieve
-      MagicWrite::Client.get(path: '/companies/current')
+      client.get(path: '/companies/current')
     end
 
     def update(parameters: {})
-      MagicWrite::Client.json_put(path: '/companies/current', parameters: parameters)
+      client.json_put(path: '/companies/current', parameters: parameters)
     end
+
+    private
+
+    attr_reader :client
   end
 end

data/lib/magicwrite/completions.rb

@@ -1,23 +1,27 @@
 module MagicWrite
   class Completions
-    def initialize(access_token: nil)
-      MagicWrite.configuration.access_token = access_token if access_token
+    def initialize(client:)
+      @client = client
     end
 
     def execute(parameters: {})
-      MagicWrite::Client.json_post(path: '/completions', parameters: parameters)
+      client.json_post(path: '/completions', parameters: parameters)
     end
 
     def retrieve(id:, parameters: {})
-      MagicWrite::Client.get(path: "/completions/#{id}", parameters: parameters)
+      client.get(path: "/completions/#{id}", parameters: parameters)
     end
 
     def create(id:, parameters: {})
-      MagicWrite::Client.json_post(path: "/completions/#{id}", parameters: parameters)
+      client.json_post(path: "/completions/#{id}", parameters: parameters)
     end
 
     def delete(id:, completion_id:)
-      MagicWrite::Client.delete(path: "/completions/#{id}/#{completion_id}")
+      client.delete(path: "/completions/#{id}/#{completion_id}")
     end
+
+    private
+
+    attr_reader :client
   end
 end

data/lib/magicwrite/error.rb

@@ -0,0 +1,20 @@
+module MagicWrite
+  class Error < StandardError
+    class BadRequest < Error; end
+    class Unauthorized < Error; end
+    class PaymentRequired < Error; end
+    class Forbidden < Error; end
+    class NotFound < Error; end
+    class MethodNotAllowed < Error; end
+    class RequestTimeout < Error; end
+    class Conflict < Error; end
+    class UnprocessableEntity < Error; end
+    class TooManyRequests < Error; end
+    class InternalServerError < Error; end
+    class NotImplemented < Error; end
+    class BadGateway < Error; end
+    class ServiceUnavailable < Error; end
+    class GatewayTimeout < Error; end
+    class UnknownError < Error; end
+  end
+end

data/lib/magicwrite/error_handler.rb

@@ -0,0 +1,38 @@
+module MagicWrite
+  class ErrorHandler
+    HTTP_CODE = {
+      400 => MagicWrite::Error::BadRequest,
+      401 => MagicWrite::Error::Unauthorized,
+      402 => MagicWrite::Error::PaymentRequired,
+      403 => MagicWrite::Error::Forbidden,
+      404 => MagicWrite::Error::NotFound,
+      405 => MagicWrite::Error::MethodNotAllowed,
+      408 => MagicWrite::Error::RequestTimeout,
+      409 => MagicWrite::Error::Conflict,
+      422 => MagicWrite::Error::UnprocessableEntity,
+      429 => MagicWrite::Error::TooManyRequests,
+      500 => MagicWrite::Error::InternalServerError,
+      501 => MagicWrite::Error::NotImplemented,
+      502 => MagicWrite::Error::BadGateway,
+      503 => MagicWrite::Error::ServiceUnavailable,
+      504 => MagicWrite::Error::GatewayTimeout
+    }.freeze
+
+    def initialize(response)
+      @response = response
+      @status = response.status
+    end
+
+    def raise_error
+      raise error_class, response.reason_phrase
+    end
+
+    private
+
+    attr_reader :response, :status
+
+    def error_class
+      HTTP_CODE[status] || MagicWrite::Error::UnknownError
+    end
+  end
+end

data/lib/magicwrite/http.rb

@@ -1,55 +1,67 @@
 module MagicWrite
   module HTTP
     def get(path:, parameters: {})
-      to_json(conn.get(uri(path: path)) do |req|
-        req.headers = headers
-        req.body = parameters.to_json
-      end&.body)
+      build_response(conn.get(uri(path: path)) do |request|
+        request.headers = headers
+        request.body = parameters.to_json
+      end)
     end
 
     def json_post(path:, parameters:)
-      to_json(conn.post(uri(path: path)) do |req|
+      build_response(conn.post(uri(path: path)) do |request|
         if parameters[:stream].respond_to?(:call)
-          req.options.on_data = to_json_stream(user_proc: parameters[:stream])
+          request.options.on_data = to_json_stream(user_proc: parameters[:stream])
           parameters[:stream] = true
         elsif parameters[:stream]
           raise ArgumentError, 'The stream parameter must be a Proc or have a #call method'
         end
 
-        req.headers = headers
-        req.body = parameters.to_json
-      end&.body)
+        request.headers = headers
+        request.body = parameters.to_json
+      end)
     end
 
     def json_put(path:, parameters:)
-      to_json(conn.put(uri(path: path)) do |req|
+      build_response(conn.put(uri(path: path)) do |request|
         if parameters[:stream].respond_to?(:call)
-          req.options.on_data = to_json_stream(user_proc: parameters[:stream])
+          request.options.on_data = to_json_stream(user_proc: parameters[:stream])
           parameters[:stream] = true
         elsif parameters[:stream]
           raise ArgumentError, 'The stream parameter must be a Proc or have a #call method'
         end
 
-        req.headers = headers
-        req.body = parameters.to_json
-      end&.body)
+        request.headers = headers
+        request.body = parameters.to_json
+      end)
     end
 
     def multipart_post(path:, parameters: nil)
-      to_json(conn(multipart: true).post(uri(path: path)) do |req|
-        req.headers = headers.merge({ 'Content-Type' => 'multipart/form-data' })
-        req.body = multipart_parameters(parameters)
-      end&.body)
+      build_response(conn(multipart: true).post(uri(path: path)) do |request|
+        request.headers = headers.merge({ 'Content-Type' => 'multipart/form-data' })
+        request.body = multipart_parameters(parameters)
+      end)
     end
 
     def delete(path:)
-      to_json(conn.delete(uri(path: path)) do |req|
-        req.headers = headers
-      end&.body)
+      build_response(conn.delete(uri(path: path)) do |request|
+        request.headers = headers
+      end)
     end
 
     private
 
+    def build_response(response)
+      return parsed_response(response) if response.status.between?(200, 299)
+
+      MagicWrite::ErrorHandler.new(response).raise_error
+    end
+
+    def parsed_response(response)
+      return unless response
+
+      to_json(response.body)
+    end
+
     def to_json(string)
       return unless string
 
@@ -69,21 +81,21 @@ module MagicWrite
     end
 
     def conn(multipart: false)
-      Faraday.new do |f|
-        f.options[:timeout] = MagicWrite.configuration.request_timeout
-        f.request(:multipart) if multipart
+      Faraday.new do |faraday|
+        faraday.options[:timeout] = @request_timeout
+        faraday.request(:multipart) if multipart
       end
     end
 
     def uri(path:)
-      File.join(MagicWrite.configuration.uri_base, path)
+      File.join(@uri_base, path)
     end
 
     def headers
       {
         'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{MagicWrite.configuration.access_token}"
-      }
+        'Authorization' => "Bearer #{@access_token}"
+      }.merge(@extra_headers || {})
     end
 
     def multipart_parameters(parameters)

data/lib/magicwrite/ingestions.rb

@@ -1,23 +1,27 @@
 module MagicWrite
   class Ingestions
-    def initialize(access_token: nil)
-      MagicWrite.configuration.access_token = access_token if access_token
+    def initialize(client:)
+      @client = client
     end
 
     def list(parameters: {})
-      MagicWrite::Client.get(path: '/ingestions', parameters: parameters)
+      client.get(path: '/ingestions', parameters: parameters)
     end
 
     def create(parameters: {})
-      MagicWrite::Client.json_post(path: '/ingestions', parameters: parameters)
+      client.json_post(path: '/ingestions', parameters: parameters)
     end
 
     def retrieve(id:)
-      MagicWrite::Client.get(path: "/ingestions/#{id}")
+      client.get(path: "/ingestions/#{id}")
     end
 
     def delete(id:)
-      MagicWrite::Client.delete(path: "/ingestions/#{id}")
+      client.delete(path: "/ingestions/#{id}")
     end
+
+    private
+
+    attr_reader :client
   end
 end

data/lib/magicwrite/memberships.rb

@@ -0,0 +1,19 @@
+module MagicWrite
+  class Memberships
+    def initialize(client:)
+      @client = client
+    end
+
+    def user
+      client.get(path: '/memberships/user')
+    end
+
+    def company
+      client.get(path: '/memberships/company')
+    end
+
+    private
+
+    attr_reader :client
+  end
+end

data/lib/magicwrite/version.rb

@@ -1,3 +1,3 @@
 module MagicWrite
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.5'.freeze
 end

data/lib/magicwrite.rb

@@ -6,16 +6,18 @@ require_relative 'magicwrite/client'
 require_relative 'magicwrite/agents'
 require_relative 'magicwrite/companies'
 require_relative 'magicwrite/completions'
+require_relative 'magicwrite/error'
+require_relative 'magicwrite/error_handler'
 require_relative 'magicwrite/ingestions'
+require_relative 'magicwrite/memberships'
 require_relative 'magicwrite/version'
 
 module MagicWrite
-  class Error < StandardError; end
   class ConfigurationError < Error; end
 
   class Configuration
     attr_writer :access_token
-    attr_accessor :uri_base, :request_timeout
+    attr_accessor :uri_base, :request_timeout, :extra_headers
 
     DEFAULT_URI_BASE = 'https://api.magicwrite.ai/rest/'.freeze
     DEFAULT_REQUEST_TIMEOUT = 120
@@ -24,6 +26,7 @@ module MagicWrite
       @access_token = nil
       @uri_base = DEFAULT_URI_BASE
       @request_timeout = DEFAULT_REQUEST_TIMEOUT
+      @extra_headers = nil
     end
 
     def access_token
@@ -36,13 +39,13 @@ module MagicWrite
 
   class << self
     attr_writer :configuration
-  end
 
-  def self.configuration
-    @configuration ||= MagicWrite::Configuration.new
-  end
+    def configuration
+      @configuration ||= MagicWrite::Configuration.new
+    end
 
-  def self.configure
-    yield(configuration)
+    def configure
+      yield(configuration)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-magicwrite
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Rodrigo Campos
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-21 00:00:00.000000000 Z
+date: 2023-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -68,8 +68,11 @@ files:
 - lib/magicwrite/companies.rb
 - lib/magicwrite/compatibility.rb
 - lib/magicwrite/completions.rb
+- lib/magicwrite/error.rb
+- lib/magicwrite/error_handler.rb
 - lib/magicwrite/http.rb
 - lib/magicwrite/ingestions.rb
+- lib/magicwrite/memberships.rb
 - lib/magicwrite/version.rb
 - lib/ruby/magicwrite.rb
 - pull_request_template.md