Fix Naming/FileName offense (#32)

Rename Colore Client according to Rubygems conventions. Ref: https://guides.rubygems.org/name-your-gem/ Additionally: fix readme
ifad · Jan 20, 2025 · bf87e81 · bf87e81
1 parent daf60eb
commit bf87e81
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 19 deletions.
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
diff --git a/README.md b/README.md
@@ -58,12 +58,13 @@ File.open( 'foo.pdf', 'wb' ) { |f| f.write(pdf) }
 ## Available Methods
 
 ```ruby
-client.create_document doc_id:, filename:, content:, title:, author:, actions:[], callback_url
-client.update_document doc_id:, version:, filename:, content:, title:, author:, actions:[], callback_url:
-client.request_conversion doc_id:, version:, filename:, action: callback_url:
+client.create_document doc_id:, filename:, content:, title:, author:, actions:, callback_url:
+client.update_document doc_id:, filename:, content:, author:, actions:, callback_url:
+client.update_title doc_id:, title:
+client.request_conversion doc_id:, filename:, action:, version:, callback_url:
 client.delete_document doc_id:
 client.delete_version doc_id:, version:
-client.get_document doc_id:, version:, filename:
+client.get_document doc_id:, filename:, version:
 client.get_document_info doc_id:
 client.convert content:, action:, language:
 ```

diff --git a/bin/colore-client b/bin/colore-client
@@ -8,7 +8,7 @@ require 'pp'
 BIN_BASE = Pathname.new(__dir__)
 $LOAD_PATH << BIN_BASE.join('../lib')
 
-require 'colore-client'
+require 'colore/client'
 
 DEFAULT_ARGS = {
   base_uri: 'http://localhost:9240/',

diff --git a/lib/colore-client.rb b/lib/colore-client.rb
diff --git a/lib/colore/client.rb b/lib/colore/client.rb
@@ -9,6 +9,9 @@
 require 'tempfile'
 require 'uri'
 
+require_relative 'client/version'
+require_relative 'errors'
+
 # The Colore module serves as the namespace for the Colore client and related classes.
 module Colore
   # The name of the 'current' version.

diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -13,7 +13,7 @@
 
 SPEC_BASE = Pathname.new(__dir__)
 
-require 'colore-client'
+require 'colore/client'
 
 def fixture(name)
   SPEC_BASE.join('fixtures', name)