ocr_space 1.0 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d6af41320b1f019a718b0a4bdf82635ff45fb83
-  data.tar.gz: fde10be5e3f5c2305ef6ee40bcfa55e562180349
+  metadata.gz: 482aa09d94f5f2a4eb0bffba5b4a3a4e3eebb2ba
+  data.tar.gz: 343592d8b308393c5fd62b516b754cd4af7cabb9
 SHA512:
-  metadata.gz: 43e8bbbc932dc61a035e38948151ef853d07b87910a706fe81559ebb7eacd757875cc54bbd03da9fae6e93bc034f2bfc6401006d31063dfd8d36bd1f25cd92c5
-  data.tar.gz: 68adbde17acbb1fa00fd87050a51c85db4fb8c6e6bdeb913694d9da9f45033301fb61bf249e77f38e4e650ffc3b827377ea5ae8b3ab9825482e0f5331bbe2c98
+  metadata.gz: 7b08e263106cd8c8b04e6bba34eccaf5e1727892794a954f168a3d28f4dad951469175a58fb59cb1de1e390392702e76af92365e6454f6bb104034d3c0e54c6f
+  data.tar.gz: a14245907adc60dc9493b7018ee72578e413180f5600dddd573f4a141083f27994520c8da287084f540ea2a4764b84534e21d146cda0cf7006dd798cf2792293

data/README.md

@@ -28,12 +28,26 @@ Hosted at [rubygems.org](https://rubygems.org/gems/ocr_space)
 
 ![Nicola Tesla](http://bit.ly/2ih9aXt)
 
-#To convert images from url
+## Instantiate OcrSpace resource with apikey
 
 ```ruby
 require 'ocr_space'
 
-result = OcrSpace::FromUrl.new(apikey: "YOUR API KEY", url: "http://bit.ly/2ih9aXt")
+resource = OcrSpace::Resource.new(apikey: "YOUR API KEY")
+#By default it picks up ocr_api_key='YOUR API KEY' from your env variables
+```
+#ENV Variables (Optional)
+setting env variables with api key is optional but for commandline interface to work you will have to set ENV variable 'ocr_api_key' to your apikey. For more details on Command line interface, scroll to the bottom of this page.
+
+```
+$ export ocr_api_key='YOUR API KEY'
+```
+
+#To convert images from url
+
+```ruby
+
+result = resource.convert url: "http://bit.ly/2ih9aXt"
 
 puts result.data
 =>  #[{"TextOverlay"=>{"Lines"=>[], "HasOverlay"=>false, "Message"=>"Text overlay is not provided as it is not requested"}, "FileParseExitCode"=>1, "ParsedText"=>"If you want to find the secrets of the \r\nuniverse, think in terms of energy, \r\nfrequency and vibration. \r\nAZ QUOTES \r\n", "ErrorMessage"=>"", "ErrorDetails"=>""}]
@@ -47,9 +61,8 @@ puts result.text_data #Clean result
 #To convert images from file upload
 
 ```ruby
-require 'ocr_space'
 
-result = OcrSpace::FromFile.new(apikey: "YOUR API KEY", files: "/Users/suyesh/Desktop/nicola_tesla.jpg")
+result = resource.convert file: "/Users/suyesh/Desktop/nicola_tesla.jpg"
 
 puts result.data #Raw result
 
@@ -63,27 +76,13 @@ puts result.text_data #Clean result
 
 #COMMAND LINE INTERFACE ***BONUS***
 
-You can run ocr_space through shell to get quick result from a image using filepath
+You can run ocr_space through shell to get quick result from a image using filepath or url
 
 ```
 $ ocrspace /Users/suyesh/Desktop/nicola_tesla.jpg
 
 => If you want to find the secrets of the universe, think in terms of energy, frequency and vibration. AZ QUOTES
 
-```
-#NOTE
-For commandline interface to work you will have to set ENV variable 'ocr_api_key' to your apikey.
-
-```
-$ export ocr_api_key='YOUR API KEY'
-```
-Also if you set env variable then you don't need to include apikey in your ruby scripts. You can just do the following -
-
-```ruby
-result = OcrSpace::FromFile.new(files: "./nicola_tesla.jpg") #for File based
-
-result = OcrSpace::FromUrl.new(url: "http://bit.ly/2ih9aXt") #for URL based
-
 ```
 
 #Optional

data/exe/ocrspace

@@ -1,13 +1,14 @@
 # !/usr/bin/env ruby
 require 'colorize'
 
-require_relative "../lib/ocr_space/from_file"
+require_relative "../lib/ocr_space/convert"
 
 if ARGV.empty?
   puts "You need to mention the image path".colorize(:red)
 else
   begin
-    result = OcrSpace::FromFile.new(files: ARGV[0])
+    resource = OcrSpace::Resource.new
+    result = resource.convert file: ARGV[0]
     puts result.text_data.colorize(:orange)
   rescue
      puts "Something went wrong, Please try again.".colorize(:red)

data/lib/ocr_space.rb

@@ -1,4 +1,19 @@
 require 'ocr_space/version'
-require 'ocr_space/from_url'
-require 'ocr_space/from_file'
+require 'ocr_space/convert'
 require 'ocr_space/banner'
+
+module OcrSpace
+  class Resource
+    attr_reader :data
+
+    include OcrSpace::Convert
+
+    def initialize(apikey: ENV['ocr_api_key'])
+      @api_key = apikey
+    end
+
+    def text_data
+        data[0]['ParsedText'].delete("\n").delete("\r").strip
+    end
+  end
+end

data/lib/ocr_space/convert.rb

@@ -0,0 +1,26 @@
+require 'ocr_space/file_post'
+
+module OcrSpace
+    module Convert
+        def convert(apikey: @api_key, language: 'eng', isOverlayRequired: false, file: nil, url: nil)
+          if file
+            @files = File.new(file)
+            @data = OcrSpace::FilePost.post('/parse/image',
+                                            body: { apikey: apikey,
+                                                    language: language,
+                                                    isOverlayRequired: isOverlayRequired,
+                                                    file: @files })
+            @data = @data.parsed_response['ParsedResults']
+          elsif url
+            @data = HTTParty.post('https://api.ocr.space/parse/image',
+                                  body: { apikey: apikey,
+                                          language: language,
+                                          isOverlayRequired: isOverlayRequired,
+                                          url: url })
+            @data = @data.parsed_response['ParsedResults']
+          else
+            "You need to Pass either file or url."
+          end
+        end
+    end
+end

data/lib/ocr_space/version.rb

@@ -1,3 +1,3 @@
 module OcrSpace
-    VERSION = '1.0'.freeze
+    VERSION = '2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocr_space
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '2.0'
 platform: ruby
 authors:
 - Suyesh Bhandari
@@ -114,9 +114,8 @@ files:
 - exe/ocrspace
 - lib/ocr_space.rb
 - lib/ocr_space/banner.rb
+- lib/ocr_space/convert.rb
 - lib/ocr_space/file_post.rb
-- lib/ocr_space/from_file.rb
-- lib/ocr_space/from_url.rb
 - lib/ocr_space/version.rb
 - ocr_space.gemspec
 homepage: https://github.com/suyesh/ocr_space

data/lib/ocr_space/from_file.rb

@@ -1,20 +0,0 @@
-require 'ocr_space/file_post'
-
-module OcrSpace
-    class File
-        attr_reader :data
-        def initialize(apikey: ENV['ocr_api_key'], language: 'eng', isOverlayRequired: false, file: nil)
-            @files = File.new(file)
-            @data = OcrSpace::FilePost.post('/parse/image',
-                                            body: { apikey: apikey,
-                                                    language: language,
-                                                    isOverlayRequired: isOverlayRequired,
-                                                    file: @files })
-            @data = @data.parsed_response['ParsedResults']
-        end
-
-        def text_data
-            data[0]['ParsedText'].delete("\n").delete("\r").strip
-        end
-    end
-end

data/lib/ocr_space/from_url.rb

@@ -1,19 +0,0 @@
-require 'httparty'
-
-module OcrSpace
-    class Url
-        attr_reader :data
-        def initialize(apikey: ENV['ocr_api_key'], language: 'eng', isOverlayRequired: false, url: nil, ocr_space: 'https://api.ocr.space/parse/image')
-            @data = HTTParty.post(ocr_space,
-                                  body: { apikey: apikey,
-                                          language: language,
-                                          isOverlayRequired: isOverlayRequired,
-                                          url: url })
-            @data = @data.parsed_response['ParsedResults']
-        end
-
-        def text_data
-            data[0]['ParsedText'].delete("\n").delete("\r").strip
-        end
-    end
-end