ruby-magicwrite 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78dec62f5b00bafdf4c419f17e5f908ce8431ed0d0ed1d5289a9b12556160990
-  data.tar.gz: d707b12d56bca20072ab023ba01f8e7f12b86ad16b675e151c6b9fc9dcd2ea51
+  metadata.gz: fe492bf84e88d0fac86ee681671ab724a7247d37403301fcc6b2d24c5db23fb0
+  data.tar.gz: 67460bd0593a9e4b7503e6e048b42d0927631c62e784951056d629edc1e99666
 SHA512:
-  metadata.gz: 218a31aab9ea79dd52f51dba0622d137ada3ee533532f49bdb06d1127aacd577873d9ea24ddca9fe7c0a50e8dca9a8c5731e4ce2c0996e4211fc270764a607b4
-  data.tar.gz: 6dab53f804184b3e3179c1a51fb5cdf00493b2ec7781e59ed1e2982565797d42b8953473f3e0789b9ef590dc5e827fd344ad86f91fd8d6a2064250b8561c41ad
+  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.4)
+    ruby-magicwrite (0.1.5)
       faraday (>= 1)
       faraday-multipart (>= 1)
 

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,35 +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
+      @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/http.rb

@@ -82,20 +82,20 @@ module MagicWrite
 
     def conn(multipart: false)
       Faraday.new do |faraday|
-        faraday.options[:timeout] = MagicWrite.configuration.request_timeout
+        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

@@ -1,15 +1,19 @@
 module MagicWrite
   class Memberships
-    def initialize(access_token: nil)
-      MagicWrite.configuration.access_token = access_token if access_token
+    def initialize(client:)
+      @client = client
     end
 
     def user
-      MagicWrite::Client.get(path: '/memberships/user')
+      client.get(path: '/memberships/user')
     end
 
     def company
-      MagicWrite::Client.get(path: '/memberships/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.4'.freeze
+  VERSION = '0.1.5'.freeze
 end

data/lib/magicwrite.rb

@@ -17,7 +17,7 @@ module MagicWrite
 
   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
@@ -26,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
@@ -38,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.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Rodrigo Campos