doxie 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 906660de3417d7d30e3a74d18dde7de388b4425d
-  data.tar.gz: ee590fbfbefa0d0c685399f3461c5b5b3aecb06d
+  metadata.gz: b397c377274d4870e902d85ae5e2b58045f35816
+  data.tar.gz: 9b8346d5b0e6420622ca033ca9341c101b2feeca
 SHA512:
-  metadata.gz: 169c926ac7383ad8c3f09cb662d78eded14c0c78533a9c8faf8565ac2fc032113406972cd6177650fde442adf1d481b3c0672ed7f414a2f427d94ca2794db525
-  data.tar.gz: d64a1da4878d1297749f3207283487985083d6a1e53133147d89e9beca3eec2ccd865f9364017c6db9aab32b22c96898ed86c3ea04bca914cbd641376ad94dae
+  metadata.gz: 43c469dfc64dea3f032ad43743406fdc3bcc464b55b1f742e26b48d9557bc1df13f1af769b84dd823facb08f11d41bbdc5a623949522bfb12618acf1c6fbf9aa
+  data.tar.gz: 9b0bfcdb9a2ad6df382fbeaa3950b257d631fb3369491432e7619f03194317f092c9ac2c197c26ecb5b78ca897bdeb93a27e2c54d72f6341c2a4a27362cc0279

data/README.md

@@ -1,4 +1,4 @@
-# Doxie Ruby API Wrapper
+# Ruby API library for Doxie Go Wifi
 
 [![Gem Version](https://badge.fury.io/rb/doxie.svg)](https://badge.fury.io/rb/doxie) [![Build Status](https://travis-ci.org/cbetta/doxie.svg?branch=master)](https://travis-ci.org/cbetta/doxie)
 
@@ -10,7 +10,7 @@ Either install directly or via bundler.
 
 ```rb
 gem 'doxie'
-gem 'doxie_scanner' # optional if your Doxie is not on a fixed IP
+gem 'doxie-scanner' # optional if your Doxie is not on a fixed IP
 ```
 
 ## Usage
@@ -20,8 +20,8 @@ gem 'doxie_scanner' # optional if your Doxie is not on a fixed IP
 This requires the [`doxie_scanner`](https://github.com/cbetta/doxie_scanner) gem. This gem has a bigger dependency than the `doxie` gem which is why it has been split into a seperate library.
 
 ```rb
-require 'doxie_scanner'
-DoxieScanner.ips
+require 'doxie/scanner'
+Doxie::Scanner.ips
 => [
     [0] "192.168.1.2"
 ]
@@ -214,6 +214,6 @@ client.delete_scans ["/DOXIE/JPEG/IMG_0001.JPG", "/DOXIE/JPEG/IMG_0002.JPG"]
 
 ## Credits and License
 
-Thanks to [@timcraft](https://github.com/timcraft) for the excellent [Nexmo Ruby livrary](https://github.com/Nexmo/nexmo-ruby) which helped me remember how to nicely wrap the Doxie API.
+Thanks to [@timcraft](https://github.com/timcraft) for the excellent [Nexmo Ruby library](https://github.com/Nexmo/nexmo-ruby) which helped me remember how to nicely wrap the Doxie API.
 
 This library is released under the [MIT License](LICENSE).

data/doxie.gemspec

@@ -3,11 +3,12 @@ require File.expand_path('lib/doxie/version', File.dirname(__FILE__))
 Gem::Specification.new do |s|
   s.name        = 'doxie'
   s.version     =  Doxie::VERSION
-  s.summary     = "Doxie API Wrapper for getting scans off your Doxie scanner"
-  s.description = "Doxie API Wrapper for getting scans off your Doxie scanner"
-  s.authors     = ["Cristiano Betta"]
+  s.summary     = 'Doxie API Wrapper for getting scans off your Doxie scanner'
+  s.description = 'Doxie API Wrapper for getting scans off your Doxie scanner'
+  s.authors     = ['Cristiano Betta']
   s.email       = 'cbetta@gmail.com'
-  s.files       = Dir.glob('{lib,spec}/**/*') + %w(LICENSE README.md doxie.gemspec)
+  s.files       = Dir.glob('{lib,spec}/**/*') +
+                  %w[LICENSE README.md doxie.gemspec]
   s.homepage    = 'https://github.com/cbetta/doxie'
   s.license     = 'MIT'
   s.require_path = 'lib'

data/lib/doxie/client.rb

@@ -2,17 +2,18 @@ require 'net/http'
 require 'json'
 
 module Doxie
+  # The client for connecting to a Doxie scanner.
+  #
+  # Use the IP and password to connect as follows:
+  #   Doxie::Client.new(ip: '192.168.1.2', password: 'test')
   class Client
     class Error < StandardError; end
-    class ClientError < Error; end
-    class ServerError < Error; end
-    class AuthenticationError < ClientError; end
 
     USERNAME = 'doxie'.freeze
 
     attr_accessor :ip, :password
 
-    def initialize options
+    def initialize(options)
       @ip = options[:ip] || ''
       @password = options[:password] || ''
     end
@@ -37,45 +38,44 @@ module Doxie
       get('/scans/recent.json')
     end
 
-    def scan scan_name, file_name = nil
+    def scan(scan_name, file_name = nil)
       file "/scans#{scan_name}", file_name
     end
 
-    def thumbnail scan_name, file_name = nil
+    def thumbnail(scan_name, file_name = nil)
       file "/thumbnails#{scan_name}", file_name
     end
 
-    def delete_scan scan_name
+    def delete_scan(scan_name)
       delete("/scans#{scan_name}")
     end
 
-    def delete_scans scan_names
-      post("/scans/delete.json", scan_names)
+    def delete_scans(scan_names)
+      post('/scans/delete.json', scan_names)
     end
 
     private
 
-    def get path
+    def get(path)
       uri = uri_for(path)
       message = Net::HTTP::Get.new(uri.request_uri)
       parse(request(uri, message))
     end
 
-    def post path, params
+    def post(path, params)
       uri = uri_for(path)
       message = Net::HTTP::Post.new(uri.request_uri)
       message.body = JSON.generate(params)
       parse(request(uri, message))
     end
 
-
-    def delete path
+    def delete(path)
       uri = uri_for(path)
       message = Net::HTTP::Delete.new(uri.request_uri)
       parse(request(uri, message))
     end
 
-    def uri_for path
+    def uri_for(path)
       URI("https://#{ip}:8080#{path}")
     end
 
@@ -85,28 +85,26 @@ module Doxie
       http.request(message)
     end
 
-    def parse response
+    def parse(response)
       case response
       when Net::HTTPNoContent
-        return true
+        true
       when Net::HTTPSuccess
-        if response['Content-Type'].split(';').first == 'application/json'
-          JSON.parse(response.body)
-        else
-          response.body
-        end
-      when Net::HTTPUnauthorized
-        raise AuthenticationError, "#{response.code} response from #{ip}"
-      when Net::HTTPClientError
-        raise ClientError, "#{response.code} response from #{ip}"
-      when Net::HTTPServerError
-        raise ServerError, "#{response.code} response from #{ip}"
+        parse_json(response)
+      else
+        raise Error, response
+      end
+    end
+
+    def parse_json(response)
+      if response['Content-Type'].split(';').first == 'application/json'
+        JSON.parse(response.body)
       else
-        raise Error, "#{response.code} response from #{ip}"
+        response.body
       end
     end
 
-    def file scan_name, file_name
+    def file(scan_name, file_name)
       body = get(scan_name)
       if file_name
         File.open(file_name, 'wb') { |file| file.write(body) }

data/lib/doxie/version.rb

@@ -1,3 +1,3 @@
 module Doxie
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'.freeze
 end

data/spec/doxie_spec.rb

@@ -5,11 +5,16 @@ require 'doxie'
 
 describe 'Doxie::Client' do
   def json_response_body(content)
-    {headers: {'Content-Type' => 'application/json;charset=utf-8'}, body: content}
+    {
+      headers: {
+        'Content-Type' => 'application/json;charset=utf-8'
+      },
+      body: content
+    }
   end
 
   before do
-    @json_response_object = {'key' => 'value'}
+    @json_response_object = { 'key' => 'value' }
     @json_response_body = json_response_body('{"key":"value"}')
     @ip = '192.168.1.1'
     @base_url = "http://#{@ip}:8080"
@@ -74,7 +79,8 @@ describe 'Doxie::Client' do
     it 'should return the result' do
       stub_request(:get, "#{@base_url}/thumbnails/DOXIE/JPEG/IMG_0001.JPG")
         .to_return(@json_response_body)
-      @client.thumbnail('/DOXIE/JPEG/IMG_0001.JPG').must_equal(@json_response_object)
+      @client.thumbnail('/DOXIE/JPEG/IMG_0001.JPG')
+             .must_equal(@json_response_object)
     end
 
     it 'should write to file' do
@@ -88,7 +94,8 @@ describe 'Doxie::Client' do
     it 'should return the result' do
       stub_request(:delete, "#{@base_url}/scans/DOXIE/JPEG/IMG_0001.JPG")
         .to_return(@json_response_body)
-      @client.delete_scan('/DOXIE/JPEG/IMG_0001.JPG').must_equal(@json_response_object)
+      @client.delete_scan('/DOXIE/JPEG/IMG_0001.JPG')
+             .must_equal(@json_response_object)
     end
   end
 
@@ -96,25 +103,26 @@ describe 'Doxie::Client' do
     it 'should return the result' do
       stub_request(:post, "#{@base_url}/scans/delete.json")
         .to_return(status: 204)
-      @client.delete_scans(['/DOXIE/JPEG/IMG_0001.JPG']).must_equal(true)
+      @client.delete_scans(['/DOXIE/JPEG/IMG_0001.JPG'])
+             .must_equal(true)
     end
   end
 
   it 'raises an authentication error exception if the response code is 401' do
     stub_request(:get, "#{@base_url}/hello.json")
       .to_return(status: 401)
-    proc { @client.hello }.must_raise(Doxie::Client::AuthenticationError)
+    proc { @client.hello }.must_raise(Doxie::Client::Error)
   end
 
   it 'raises a client error exception if the response code is 4xx' do
     stub_request(:get, "#{@base_url}/hello.json")
       .to_return(status: 400)
-    proc { @client.hello }.must_raise(Doxie::Client::ClientError)
+    proc { @client.hello }.must_raise(Doxie::Client::Error)
   end
 
   it 'raises a server error exception if the response code is 5xx' do
     stub_request(:get, "#{@base_url}/hello.json")
       .to_return(status: 500)
-    proc { @client.hello }.must_raise(Doxie::Client::ServerError)
+    proc { @client.hello }.must_raise(Doxie::Client::Error)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doxie
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Cristiano Betta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-30 00:00:00.000000000 Z
+date: 2017-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Doxie API Wrapper for getting scans off your Doxie scanner