barcoder-client 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+gem 'activesupport'
+gem 'activemodel'
+gem 'typhoeus'
+gem 'yajl-ruby'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec"
+  gem "rdoc"
+  gem "bundler"
+  gem "jeweler"
+  gem "simplecov"
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    ethon (0.5.9)
+      ffi (~> 1.2.0)
+      mime-types (~> 1.18)
+    ffi (1.2.1)
+    git (1.2.5)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    mime-types (1.21)
+    multi_json (1.6.1)
+    rake (10.0.3)
+    rdoc (3.12.1)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    typhoeus (0.6.1)
+      ethon (~> 0.5.9)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel
+  activesupport
+  bundler
+  jeweler
+  rdoc
+  rspec
+  simplecov
+  typhoeus
+  yajl-ruby

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Ryan Winograd
+
+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.rdoc

@@ -0,0 +1,19 @@
+= barcoder-client
+
+Description goes here.
+
+== Contributing to barcoder-client
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Ryan Winograd. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "barcoder-client"
+  gem.homepage = "http://github.com/rylwin/barcoder-client"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby client to access the Barcoder}
+  gem.description = %Q{Ruby client to access the Barcoder}
+  gem.email = "ryan@thewinograds.com"
+  gem.authors = ["Ryan Winograd"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "barcoder-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/barcoder-client.gemspec

@@ -0,0 +1,86 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "barcoder-client"
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Winograd"]
+  s.date = "2013-02-19"
+  s.description = "Ruby client to access the Barcoder"
+  s.email = "ryan@thewinograds.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "barcoder-client.gemspec",
+    "lib/barcoder-client.rb",
+    "lib/barcoder/base.rb",
+    "lib/barcoder/bucket.rb",
+    "lib/barcoder/config.rb",
+    "lib/barcoder/page.rb",
+    "lib/barcoder/pdf.rb",
+    "spec/assets/barcoded-1.pdf",
+    "spec/assets/unbarcoded-1.pdf",
+    "spec/assets/unbarcoded-2.pdf",
+    "spec/assets/unbarcoded.pdf",
+    "spec/bucket_spec.rb",
+    "spec/page_spec.rb",
+    "spec/pdf_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/rylwin/barcoder-client"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Ruby client to access the Barcoder"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<activemodel>, [">= 0"])
+      s.add_runtime_dependency(%q<typhoeus>, [">= 0"])
+      s.add_runtime_dependency(%q<yajl-ruby>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<activemodel>, [">= 0"])
+      s.add_dependency(%q<typhoeus>, [">= 0"])
+      s.add_dependency(%q<yajl-ruby>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<activemodel>, [">= 0"])
+    s.add_dependency(%q<typhoeus>, [">= 0"])
+    s.add_dependency(%q<yajl-ruby>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/barcoder-client.rb

@@ -0,0 +1,15 @@
+require 'yajl'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/concern'
+require 'active_model'
+require 'typhoeus'
+
+require 'base64'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'barcoder/config'
+require 'barcoder/base'
+require 'barcoder/bucket'
+require 'barcoder/pdf'
+require 'barcoder/page'

data/lib/barcoder/base.rb

@@ -0,0 +1,51 @@
+class Barcoder::Base
+  include ActiveModel::Serializers::JSON
+  include ActiveModel::Validations
+
+  def initialize(attributes_or_json={})
+    self.attributes = attributes_or_json
+  end
+
+  def attributes=(attributes_or_json)
+    if attributes_or_json.is_a? String
+      from_json(attributes_or_json)
+      attributes = attributes.with_indifferent_access
+    else
+      attributes = attributes_or_json.with_indifferent_access
+    end
+
+    attributes.each do |field, val|
+      send("#{field}=", val)
+    end
+  end
+
+  private
+
+  def process_save_response(response)
+    data = response_to_attr(response)
+    self.attributes = data
+  end
+
+  # Instance-level conversion of response to attributes
+  def response_to_attr(response)
+    data = self.class.response_to_attr(response)
+    data.merge! persisted: true if respond_to?(:persisted=)
+    data
+  end
+
+  # Class-level conversion of response to attributes
+  def self.response_to_attr(response)
+    data = response_to_json(response).with_indifferent_access
+    data[:pages] = data[:pages].map {|p| Barcoder::Page.new(p)} if data[:pages]
+    data
+  end
+
+  def self.response_to_json(response)
+    Yajl::Parser.parse(response.body)
+  end
+
+  def response_to_json(response)
+    self.class.response_to_json response
+  end
+
+end

data/lib/barcoder/bucket.rb

@@ -0,0 +1,155 @@
+class Barcoder::Bucket < Barcoder::Base
+
+  attr_accessor :name, :token, :import_hook, :persisted
+
+  validates :name, :name, presence: true
+
+  # Returns an array of all Buckets belonging to the account identified by the
+  # account_token (see Barcoder::Config).
+  def self.all(&block)
+    response = Typhoeus::Request.new(buckets_uri).run
+
+    buckets_data = response_to_json(response)
+
+    buckets = buckets_data.map do |data|
+      new(data.merge(persisted: true))
+    end
+
+    buckets
+  end
+
+  def self.buckets_uri
+    "#{Barcoder::Config.host}/buckets?token=#{Barcoder::Config.account_token}"
+  end
+
+  def self.bucket_uri(bucket)
+    "#{Barcoder::Config.host}/bucket"
+  end
+
+  def decode_from_file(filename)
+    return false unless token.present?
+    Barcoder::PDF.decode_from_file(self, filename)
+  end
+
+  def decode_from_string(string)
+    return false unless token.present?
+    Barcoder::PDF.decode_from_string(self, string)
+  end
+
+  # Fetches unmatched_pages.
+  #
+  # This method is also queueable by calling #queue_unmatched_pages.
+  def unmatched_pages(use_cache=true)
+    (use_cache && @unmatched_pages) || begin
+      unmatched_pages_request.run
+    end
+
+    @unmatched_pages
+  end
+
+  # Fetches recent_imports.
+  #
+  # This method is also queueable by calling #queue_recent_imports.
+  def recent_imports(since, use_cache=true)
+    (use_cache && @recent_imports) || begin
+      recent_imports_request(since).run
+    end
+
+    @recent_imports
+  end
+
+  # Fetches partial_imports.
+  #
+  # This method is also queueable by calling #queue_partial_imports.
+  def partial_imports(use_cache=true)
+    (use_cache && @partial_imports) || begin
+      partial_imports_request.run
+    end
+
+    @partial_imports
+  end
+
+  # Persists the Bucket.
+  def save
+    return false unless valid?
+
+    if !persisted
+      create_bucket!
+    else
+      update_bucket!
+    end
+
+    true
+  end
+
+  def method_missing(symbol, *args)
+    # e.g., if users calls queue_unmatched_pages, add unmatched_pages_request
+    # to hydra queue
+    if symbol.to_s =~ /queue_(.*)/
+      request_method = "#{$1}_request"
+      Barcoder::Config.hydra.queue send(request_method, *args)
+    else
+      super
+    end
+  end
+
+  private
+
+  def unmatched_pages_request
+    url = "#{Barcoder::Config.host}/unmatched_pages"
+    request = Typhoeus::Request.new(url, params: {token: token})
+
+    request.on_success do |response|
+      json = response_to_json(response)
+      @unmatched_pages = json.map { |j|
+        Barcoder::Page.new(j.with_indifferent_access) }
+    end
+
+    request
+  end
+
+  def recent_imports_request(since)
+    url = "#{Barcoder::Config.host}/recent_imports"
+    params = {token: token, since: since}
+    request = Typhoeus::Request.new(url, params: params)
+
+    request.on_success do |response|
+      json = response_to_json(response)
+      @recent_imports = json.map { |j|
+        Barcoder::PDF.new(j.with_indifferent_access) }
+    end
+
+    request
+  end
+
+  def partial_imports_request
+    url = "#{Barcoder::Config.host}/partial_imports"
+    params = {token: token}
+    request = Typhoeus::Request.new(url, params: params)
+
+    request.on_success do |response|
+      json = response_to_json(response)
+      @partial_imports = json.map { |j|
+        Barcoder::PDF.new(j.with_indifferent_access) }
+    end
+
+    request
+  end
+
+  def create_bucket!
+    opt = {body: save_attr, method: :post}
+    response = Typhoeus::Request.new(self.class.buckets_uri, opt).run
+    process_save_response response
+  end
+
+  def update_bucket!
+    opt = {params: save_attr.merge(token: token), method: :put}
+    response = Typhoeus::Request.new(self.class.bucket_uri(self), opt).run
+    process_save_response response
+  end
+
+  def save_attr
+    {name: name, import_hook: import_hook}
+  end
+
+end