unstructured 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66c48cd9be308e1d08567869d61c5fb450a1251928dd9f013313096224b4735b
-  data.tar.gz: 77ddd812edc3de3c23a1419e11179906c51f78ebe9ac3849f4401fd61d931436
+  metadata.gz: 04e91f2dee32fa32fbfc2907d12cd0489a6e9380ea0c7a93f61f3e27fe23be2f
+  data.tar.gz: f94417fd4bc69180c9eff4ec6cc38d82b74111ae4275cb5b1b04f1badccc4e44
 SHA512:
-  metadata.gz: 9c3b456532eb9739f883f3299d69556259687df63c4b253b8caf3d0745aca6f7563eeaf29110e6c1660bb6ab7aaed8094362ae3af28c27cfd2e0f6b656e5e087
-  data.tar.gz: a8e7bc04334a13d214e7d9f32bb0f8e6cc512632e1c96c14873c6c931030aac552a9ac5815b7df6755ca52edf4ed16785abc501972cae7f642854ec0fcf9c24a
+  metadata.gz: e603eb1ea45a348ff0b5c3edcc4ef54e1894906a74d3359a0fc41a039448ed49a73493054ced67488e9f1f543bca54833c31ad46cbb49ba8dd424a56637b0b23
+  data.tar.gz: 66c72aba06d0bc640aade82cdb8b02835818a08cc57fe95b071f36573031b7184c16cfb98518c27d19d6858912fead04201f9acc52f9a5e15e6c2c971f96f92f

data/README.md

@@ -3,17 +3,19 @@ This is a Ruby client for the [Unstructured API](https://unstructured-io.github.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+    $ bundle add unstructured
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+    $ gem install unstructured
+```
 
 ## Usage
+Find all available params on [Unstructured documentation](https://unstructured-io.github.io/unstructured/apis/api_parameters.html)
+
 ```ruby
 server_url = "https://api.unstructured.io" # "http://localhost:8000" if you are running a docker container
 client = Unstructured::Client.new(server_url: server_url, api_key: ENV["UNSTRUCTURED_API_KEY"])
@@ -28,7 +30,6 @@ params = {
   new_after_n_chars: 1000
 }
 chunks = client.partition(file_path, params)
-
 ```
 
 ## Development

data/lib/unstructured/client.rb

@@ -31,8 +31,8 @@ module Unstructured
       ChunkCollection.from_response handle_response(connection.post(
                                                       "/general/v0/general",
                                                       default_params.merge(params).merge({
-                                                                             files: files(file_path)
-                                                                           }),
+                                                                                           files: files(file_path)
+                                                                                         }),
                                                       headers
                                                     ))
     end

data/lib/unstructured/object.rb

@@ -3,7 +3,10 @@
 require "ostruct"
 module Unstructured
   class Object
+    attr_reader :attributes, :raw_data
+
     def initialize(attributes)
+      @raw_data = attributes
       @attributes = OpenStruct.new(attributes)
     end
 
@@ -16,5 +19,9 @@ module Unstructured
     def respond_to_missing?(_method, _include_private = false)
       true
     end
+
+    def to_h
+      @raw_data
+    end
   end
 end

data/lib/unstructured/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Unstructured
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unstructured
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jose Fernando Davila