doxie 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e336a766a3199d5e6702c2035fc9413c7ba0d9a
-  data.tar.gz: 0163ca246b0e2df35f580858416b4d07367e5682
+  metadata.gz: 51d0c17e145193ebfec7231b9c9113799c384305
+  data.tar.gz: 7fae9d4100c33a0eedfd83fe7637ea1b878a1284
 SHA512:
-  metadata.gz: 601ad9ce03000092f90d0681ffa851c017713cb37e284af7d66e2b94a65abd05921b4643e046b3cf80718fc8d97b656d16211850fdfeb4d660f7b068a7816dca
-  data.tar.gz: 3122dbd27a93d9fe3e070c526b160645f63b17d9a7ca109e1a126a988ca385fe700e44777c99e79c856941e23bd5dabe6204f047d302bf2e61cdb45c495fc96c
+  metadata.gz: e8be18b7473ac8eeba04d4d297e0389ce12357ca328639c1113094880c6d560acbc9131bc50e808698f951c3ce4f005baf83164adcd7a1d922f9e40188e0e055
+  data.tar.gz: 3c3188c4e7d0e2c45b333a6c42d4436baf40aaf4b2ebba6c93bccb46a53bb310d85446e24f495c55988ce87d01098f5f1ba6a83e182ad4f5377c6893d1211466

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Cristiano Betta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# Doxie Ruby API Wrapper
+
+[![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)
+
+A wrapper for the Doxie Go Wifi API. Specification as per the [developer documentation](http://help.getdoxie.com/content/doxiego/05-advanced/03-wifi/04-api/Doxie-API-Developer-Guide.pdf).
+
+## Installation
+
+Either install directly or via bundler.
+
+```rb
+gem 'doxie'
+```
+
+## Usage
+
+### Client
+
+The client accepts an `ip` and `password`. You can omit the `password` if your Doxie has non set.
+
+```rb
+require 'doxie'
+client = Doxie::Client.new(ip: '192.168.1.2', password: 'test')
+```
+
+### GET /hello.json
+
+```rb
+client.hello
+=> {
+           "model" => "DX250",
+            "name" => "Doxie_062300",
+    "firmwareWiFi" => "1.29",
+     "hasPassword" => true,
+             "MAC" => "00:11:11:11:11:00",
+            "mode" => "Client",
+         "network" => "YourWifi",
+              "ip" => "192.168.1.2"
+}
+```
+
+### GET /hello_extra.json
+
+```rb
+client.hello_extra
+=> {
+                    "firmware" => "0.26",
+    "connectedToExternalPower" => true
+}
+```
+
+### GET /restart.json
+
+```rb
+client.restart
+=> true
+```
+
+### GET /scans.json
+
+```rb
+client.scans
+=> [
+    [0] {
+            "name" => "/DOXIE/JPEG/IMG_0001.JPG",
+            "size" => 900964,
+        "modified" => "2010-05-01 00:02:38"
+    }
+]
+```
+
+
+### GET /scans/recent.json
+
+```rb
+client.recent_scans
+=> {
+    "path" => "/DOXIE/JPEG/IMG_0001.JPG"
+}
+```
+
+### GET /scans/DOXIE/JPEG/IMG_XXXX.JPG
+
+There are 2 ways to get a scan off your Doxie. The first is to get the raw binary content and then do something with it yourself.
+
+```rb
+client.scan "/DOXIE/JPEG/IMG_0001.JPG"
+=> "...?]?1:Xt?????'A??}:<??13???z*???}?rT???????z!ESj?/?..."
+```
+
+The other is to pass in a filename:
+
+```rb
+client.scan "/DOXIE/JPEG/IMG_0001.JPG", 'test.jpg'
+=> true
+```
+
+## Contributing
+
+ 1. **Fork** the repo on GitHub
+ 2. **Clone** the project to your own machine
+ 3. **Commit** changes to your own branch
+ 4. **Push** your work back up to your fork
+ 5. Submit a **Pull request** so that we can review your changes
+
+### Development
+
+* `bundle install` to get dependencies
+* `rake` to run tests
+* `rake console` to run a local console with the library loaded
+
+## 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.
+
+This library is released under the [MIT License](LICENSE).

data/doxie.gemspec

@@ -0,0 +1,18 @@
+
+Gem::Specification.new do |s|
+  s.name        = 'doxie'
+  s.version     = '0.0.7'
+  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.homepage    = 'https://github.com/cbetta/doxie'
+  s.license     = 'MIT'
+  s.require_path = 'lib'
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('webmock')
+  s.add_development_dependency('minitest')
+  s.add_development_dependency('fakefs')
+end

data/lib/doxie.rb

@@ -1,5 +1,89 @@
-class Doxie
+require 'net/http'
+require 'json'
 
-end
+module Doxie
+  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
+      @ip = options[:ip] || ''
+      @password = options[:password] || ''
+    end
+
+    def hello
+      get('/hello.json')
+    end
+
+    def hello_extra
+      get('/hello_extra.json')
+    end
+
+    def restart
+      get('/restart.json')
+    end
+
+    def scans
+      get('/scans.json')
+    end
 
-require "doxie/client"
+    def recent_scans
+      get('/scans/recent.json')
+    end
+
+    def scan scan_name, file_name = nil
+      file "/scans#{scan_name}", file_name
+    end
+
+    private
+
+    def get path
+      uri = URI("https://#{ip}:8080#{path}")
+      message = Net::HTTP::Get.new(uri.request_uri)
+      parse(request(uri, message))
+    end
+
+    def request(uri, message)
+      message.basic_auth USERNAME, password if password
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.request(message)
+    end
+
+    def parse response
+      case response
+      when Net::HTTPNoContent
+        return nil
+      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}"
+      else
+        raise Error, "#{response.code} response from #{ip}"
+      end
+    end
+
+    def file scan_name, file_name
+      body = get(scan_name)
+      if file_name
+        File.open(file_name, 'wb') { |file| file.write(body) }
+        true
+      else
+        body
+      end
+    end
+  end
+end

data/spec/doxie_spec.rb

@@ -0,0 +1,90 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'fakefs'
+require 'doxie'
+
+describe 'Doxie::Client' do
+  def json_response_body(content)
+    {headers: {'Content-Type' => 'application/json;charset=utf-8'}, body: content}
+  end
+
+  before do
+    @json_response_object = {'key' => 'value'}
+    @json_response_body = json_response_body('{"key":"value"}')
+    @ip = '192.168.1.1'
+    @base_url = "http://#{@ip}:8080"
+    @client = Doxie::Client.new(ip: @ip)
+  end
+
+  describe 'get /hello.json' do
+    it 'should return the result' do
+      stub_request(:get, "#{@base_url}/hello.json")
+        .to_return(@json_response_body)
+      @client.hello.must_equal(@json_response_object)
+    end
+  end
+
+  describe 'get /hello_extra.json' do
+    it 'should return the result' do
+      stub_request(:get, "#{@base_url}/hello_extra.json")
+        .to_return(@json_response_body)
+      @client.hello_extra.must_equal(@json_response_object)
+    end
+  end
+
+  describe 'get /restart.json' do
+    it 'should return the result' do
+      stub_request(:get, "#{@base_url}/restart.json")
+        .to_return(status: 204)
+      @client.restart.must_equal(nil)
+    end
+  end
+
+  describe 'get /scans.json' do
+    it 'should return the result' do
+      stub_request(:get, "#{@base_url}/scans.json")
+        .to_return(@json_response_body)
+      @client.scans.must_equal(@json_response_object)
+    end
+  end
+
+  describe 'get /scans/recent.json' do
+    it 'should return the result' do
+      stub_request(:get, "#{@base_url}/scans/recent.json")
+        .to_return(@json_response_body)
+      @client.recent_scans.must_equal(@json_response_object)
+    end
+  end
+
+  describe 'get /scans/DOXIE/JPEG/IMG_0001.JPG' do
+    it 'should return the result' do
+      stub_request(:get, "#{@base_url}/scans/DOXIE/JPEG/IMG_0001.JPG")
+        .to_return(@json_response_body)
+      @client.scan('/DOXIE/JPEG/IMG_0001.JPG').must_equal(@json_response_object)
+    end
+
+    it 'should write to file' do
+      stub_request(:get, "#{@base_url}/scans/DOXIE/JPEG/IMG_0001.JPG")
+        .to_return(@json_response_body)
+      @client.scan('/DOXIE/JPEG/IMG_0001.JPG', 'test.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)
+  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)
+  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)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doxie
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Cristiano Betta
@@ -72,7 +72,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- doxie.gemspec
 - lib/doxie.rb
+- spec/doxie_spec.rb
 homepage: https://github.com/cbetta/doxie
 licenses:
 - MIT