♻️ reworked entire project structure & syntax (#39)

Author: sebastianMindee

README.md

@@ -33,8 +33,11 @@ require 'mindee'
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
 # Load a file from disk and parse it
-result = mindee_client.doc_from_path('/path/to/the/file.ext')
-  .parse(Mindee::Prediction::InvoiceV4)
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+result = mindee_client.parse(
+  input_source,
+  Mindee::Product::Invoice::InvoiceV4
+)
 
 # Print a full summary of the parsed data in RST format
 puts result.document
@@ -48,8 +51,12 @@ require 'mindee'
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
 # Load a file from disk and parse it
-doc = mindee_client.doc_from_path('/path/to/the/file.ext')
-result = doc.parse(Mindee::Prediction::EU::LicensePlateV1)
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+result = mindee_client.parse(
+  input_source,
+  Mindee::Product::EU::LicensePlate::LicensePlateV1
+)
 
 # Print a full summary of the parsed data in RST format
 puts result.document
@@ -60,14 +67,20 @@ puts result.document
 require 'mindee'
 
 # Init a new client and configure your custom document
-mindee_client = Mindee::Client.new(api_key: 'my-api-key').add_endpoint(
-  'my-account',
-  'my-endpoint'
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+endpoint = mindee_client.create_endpoint(
+  endpoint_name: 'my-endpoint',
+  account_name: 'my-account'
 )
 
 # Load a file from disk and parse it
-doc = mindee_client.doc_from_path('/path/to/the/file.ext')
-result = mindee_client.parse(doc, Mindee::Prediction::CustomV1, endpoint_name: 'my-endpoint')
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+result = mindee_client.parse(
+  input_source,
+  Mindee::Product::Custom::CustomV1,
+  endpoint: endpoint
+)
 
 # Print a full summary of the parsed data in RST format
 puts result.document

bin/mindee.rb

@@ -8,51 +8,51 @@
 DOCUMENTS = {
   "custom" => {
     help: "Custom document type from API builder",
-    prediction: Mindee::Prediction::CustomV1,
+    prediction: Mindee::Product::Custom::CustomV1,
   },
   "proof-of-address" => {
     help: 'Proof of Address',
-    prediction: Mindee::Prediction::ProofOfAddressV1,
+    prediction: Mindee::Product::ProofOfAddress::ProofOfAddressV1,
   },
   "financial-document" => {
     help: 'Financial Document',
-    prediction: Mindee::Prediction::FinancialDocumentV1,
+    prediction: Mindee::Product::FinancialDocument::FinancialDocumentV1,
   },
   "invoice" => {
     help: 'Invoice',
-    prediction: Mindee::Prediction::InvoiceV4,
+    prediction: Mindee::Product::Invoice::InvoiceV4,
   },
   "receipt" => {
     help: "Expense Receipt",
-    prediction: Mindee::Prediction::ReceiptV5,
+    prediction: Mindee::Product::Receipt::ReceiptV5,
   },
   "passport" => {
     help: "Passport",
-    prediction: Mindee::Prediction::PassportV1,
+    prediction: Mindee::Product::Passport::PassportV1,
   },
   "eu-license-plate" => {
     help: "EU License Plate",
-    prediction: Mindee::Prediction::EU::LicensePlateV1,
+    prediction: Mindee::Product::EU::LicensePlate::LicensePlateV1,
   },
   "fr-bank-account-details" => {
     help: "FR Bank Account Details",
-    prediction: Mindee::Prediction::FR::BankAccountDetailsV1,
+    prediction: Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV1,
   },
   "fr-carte-vitale" => {
     help: "FR Carte Vitale",
-    prediction: Mindee::Prediction::FR::CarteVitaleV1,
+    prediction: Mindee::Product::FR::CarteVitale::CarteVitaleV1,
   },
   "fr-id-card" => {
     help: "FR ID Card",
-    prediction: Mindee::Prediction::FR::IdCardV1,
+    prediction: Mindee::Product::FR::IdCard::IdCardV1,
   },
   "us-bank-check" => {
     help: "US Bank Check",
-    prediction: Mindee::Prediction::US::BankCheckV1,
+    prediction: Mindee::Product::US::BankCheck::BankCheckV1,
   },
   "invoice-splitter" => {
     help: "US Bank Check",
-    prediction: Mindee::Prediction::InvoiceSplitterV1,
+    prediction: Mindee::Product::InvoiceSplitter::InvoiceSplitterV1,
   },
 }
 
@@ -127,9 +127,6 @@ def custom_subcommand(options)
   end
   doc_type = ARGV[0]
   file_path = ARGV[1]
-  mindee_client.add_endpoint(
-    options[:account_name], doc_type, version: options[:version] || '1',
-  )
 else
   if ARGV.length != 1
     $stderr.puts 'No file specified.'
@@ -145,8 +142,8 @@ def custom_subcommand(options)
   on_min_pages: 0,
 }
 page_options = options[:cut_pages].nil? ? nil : default_cutting
-doc = mindee_client.doc_from_path(file_path)
-result = doc.parse(DOCUMENTS[command][:prediction], endpoint_name: doc_type, page_options: page_options)
+input_source = mindee_client.source_from_path(file_path)
+result = mindee_client.parse(input_source, DOCUMENTS[command][:prediction], page_options: page_options)
 if options[:print_full]
   puts result.document
 else

docs/code_samples/bank_account_details_v1.txt

@@ -3,9 +3,14 @@ require 'mindee'
 # Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
-doc = mindee_client.doc_from_path('/path/to/the/file.ext')
-result = mindee_client.parse(doc, Mindee::Prediction::FR::BankAccountDetailsV1)
+# Load a file from disk
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+# Parse the file
+result = mindee_client.parse(
+  input_source,
+  Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV1
+)
 
 # Print a full summary of the parsed data in RST format
 puts result.document

docs/code_samples/bank_check_v1.txt

@@ -3,9 +3,14 @@ require 'mindee'
 # Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
-doc = mindee_client.doc_from_path('/path/to/the/file.ext')
-result = mindee_client.parse(doc, Mindee::Prediction::US::BankCheckV1)
+# Load a file from disk
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+# Parse the file
+result = mindee_client.parse(
+  input_source,
+  Mindee::Product::US::BankCheck::BankCheckV1
+)
 
 # Print a full summary of the parsed data in RST format
 puts result.document

docs/code_samples/carte_vitale_v1.txt

@@ -3,12 +3,17 @@ require 'mindee'
 # Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Load a file from disk and parse it
-doc = mindee_client.doc_from_path('/path/to/the/file.ext')
-result = mindee_client.parse(doc, Mindee::Prediction::FR::CarteVitaleV1)
+# Load a file from disk
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+# Parse the file
+result = mindee_client.parse(
+  input_source,
+  Mindee::Product::FR::CarteVitale::CarteVitaleV1
+)
 
 # Print a full summary of the parsed data in RST format
 puts result.document
 
 # Print the document-level parsed data
-# puts result.document.inference.prediction
+# puts result.document.inference.prediction

docs/code_samples/custom_v1.txt

@@ -1,14 +1,23 @@
 require 'mindee'
 
-# Init a new client and configure your custom document
-mindee_client = Mindee::Client.new(api_key: 'my-api-key').add_endpoint(
-  'my-account',
-  'my-endpoint'
-)
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
 # Load a file from disk and parse it
-doc = mindee_client.doc_from_path('/path/to/the/file.ext')
-result = mindee_client.parse(doc, Mindee::Prediction::CustomV1, endpoint_name: 'my-endpoint')
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+# Initialize a custom endpoint for this product
+custom_endpoint = mindee_client.create_endpoint(
+  account_name: 'my-account',
+  endpoint_name: 'my-endpoint'
+)
+
+# Send our document
+result = mindee_client.parse(
+  input_source,
+  Mindee::Product::Custom::CustomV1,
+  endpoint: custom_endpoint
+)
 
 # Print a full summary of the parsed data in RST format
 puts result.document

docs/code_samples/default.txt

@@ -2,15 +2,23 @@ require 'uri'
 require 'net/http'
 require 'net/https'
 
-url = URI('https://api.mindee.net/v1/products/mindee/my-endpoint/my-version/predict')
+api_key = "my-api-key"
+account = "my-account"
+endpoint = "my-endpoint"
+version = "my-version"
+
+url = URI("https://api.mindee.net/v1/products/#{account}/#{endpoint}/v#{version}/predict")
 file = '/path/to/the/file.ext'
 
 http = Net::HTTP.new(url.host, url.port)
 http.use_ssl = true
 
 request = Net::HTTP::Post.new(url)
-request['Authorization'] = 'Token my-api-key'
+request['Authorization'] = "Token #{api_key}"
 request.set_form([['document', File.open(file)]], 'multipart/form-data')
 
 response = http.request(request)
+if !response.kind_of? Net::HTTPSuccess
+  raise response.msg
+end
 puts response.read_body

docs/code_samples/expense_receipts_v4.txt

@@ -4,8 +4,13 @@ require 'mindee'
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
 # Load a file from disk and parse it
-doc = mindee_client.doc_from_path('/path/to/the/file.ext')
-result = mindee_client.parse(doc, Mindee::Prediction::ReceiptV4)
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+# Send our document
+result = mindee_client.parse(
+  input_source,
+  Mindee::Product::Receipt::ReceiptV4
+)
 
 # Print a full summary of the parsed data in RST format
 puts result.document

docs/code_samples/expense_receipts_v5.txt

@@ -1,11 +1,16 @@
 require 'mindee'
 
-# Init a new client, specifying an API key
+# Init a new client
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
 # Load a file from disk and parse it
-doc = mindee_client.doc_from_path('/path/to/the/file.ext')
-result = mindee_client.parse(doc, Mindee::Prediction::ReceiptV5)
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+# Send our document
+result = mindee_client.parse(
+  input_source,
+  Mindee::Product::Receipt::ReceiptV5
+)
 
 # Print a full summary of the parsed data in RST format
 puts result.document

docs/code_samples/financial_document_v1.txt

@@ -4,8 +4,13 @@ require 'mindee'
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
 # Load a file from disk and parse it
-doc = mindee_client.doc_from_path('/path/to/the/file.ext')
-result = mindee_client.parse(doc, Mindee::Prediction::FinancialDocumentV1)
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+# Send our document
+result = mindee_client.parse(
+  input_source,
+  Mindee::Product::FinancialDocument::FinancialDocumentV1
+)
 
 # Print a full summary of the parsed data in RST format
 puts result.document