franklin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b7efde29c026dbc795cbe81417a627ef35ca556
+  data.tar.gz: 71cc18d43c0e669942f9133e2326ee66b3060279
+SHA512:
+  metadata.gz: 46bd872e98f7190a6e3cf69bffad1acbd49e816a2ea58e1f8e51d681b850030aa92c4702f26c59fb90f87098208f8f1b504437e7f07d243a463b3d8656501bb2
+  data.tar.gz: 2788cc2a039330ea05d811028266d67754d3dc9d306f1b0570a96c9d003ce38781d14c0052462629c6a89152d0603c1ebdf5d60d85fc4330e4b25824e3802fa9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in franklin.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ylan Segal
+
+MIT License
+
+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,84 @@
+# Franklin
+
+Franklin is a command line utility, written in ruby, that allows searching public libraries powered by Overdrive. It supports multiple library searching for those that have accounts in more than one library (city, county, state, etc.)
+
+## Installation
+
+Install gem:
+
+    $ gem install franklin
+
+## Configuration
+
+Franklin needs to be configured with information about the Overdrive libraries it will search. It expects a file in YAML format to exist in your home directory called `.franklin`. The contents of the file should look like:
+
+``` yml
+---
+:libraries:
+  - :name: San Francisco Public Library
+    :url: http://sfpl.lib.overdrive.com
+  - :name: San Diego Public Library
+    :url: http://sdpl.lib.overdrive.com
+```
+
+There needs to be a minimum of one library, but there is no maximum. The `name` can be anything and will be included when the search results are presented. The `url` should point to the domain of the public library. It can be obtained by visiting Overdrive's site for each library, copying the url and striping everything after the domain name.
+
+## Usage
+
+Once the library has been installed and configured, the `franklin` executable will be available. It can be called from the command line with the list of terms to be searched for:
+
+```
+$ franklin chamber of secrets
+Searched for: chamber of secrets
+======================================================
+Harry Potter and the Chamber of Secrets
+By J.K. Rowling
+Format: Audiobook
+Availability:
+  2.8 people/copy @ San Francisco Public Library
+  15.5 people/copy @ San Diego Public Library
+  1.3 people/copy @ San Diego County Library
+  5.4 people/copy @ Los Angeles County Library
+======================================================
+Harry Potter and the Chamber of Secrets
+By J.K. Rowling
+Format: eBook
+Availability:
+  0.9 people/copy @ San Francisco Public Library
+  Available @ San Diego Public Library
+  0.6 people/copy @ San Diego County Library
+  0.0 people/copy @ Los Angeles County Library
+======================================================
+Harry Potter
+By Chris Peacock
+Format: eBook
+Availability:
+  2.5 people/copy @ San Francisco Public Library
+  1.0 people/copy @ San Diego Public Library
+======================================================
+Room at Heron's Inn
+By Ginger Chambers
+Format: eBook
+Availability:
+  Available @ San Francisco Public Library
+======================================================
+The Secret of the Fiery Chamber
+By Carolyn Keene
+Format: eBook
+Availability:
+  Available @ San Diego County Library
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ylansegal/franklin.
+
+## License
+
+This software is provided under the terms of the MIT license. See LICENSE.txt for more information

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "franklin"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/franklin

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require "franklin"
+
+begin
+  Franklin.run(nil, ARGV.join(" "), STDOUT)
+rescue ArgumentError => ex
+  puts <<-ERROR.gsub(/^  /, "")
+  Oops! #{ex.message}"
+  Usage: franklin search_term [other_term..]"
+  ERROR
+rescue Errno::ENOENT
+  puts <<-ERROR.gsub(/^  /, "")
+  Oops! It looks like you have not configured franklin
+  Please add a configuration file in $HOME/.franklin that looks like this:
+  ---
+  :libraries:
+    - :name: San Francisco Public Library
+      :url: http://sfpl.lib.overdrive.com
+    - :name: San Diego Public Library
+      :url: http://sdpl.lib.overdrive.com
+  ERROR
+end

data/franklin.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "franklin/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "franklin"
+  spec.version       = Franklin::VERSION
+  spec.license       = "MIT"
+  spec.authors       = ["Ylan Segal"]
+  spec.email         = ["ylan@segal-family.com"]
+
+  spec.summary       = "CLI utility for searching Overdrive-powered public libraries"
+  spec.homepage      = "https://github.com/ylansegal/franklin"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mechanize", "~> 2.7"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.22"
+end

data/lib/franklin/availability.rb

@@ -0,0 +1,3 @@
+module Franklin
+  Availability = Struct.new(:library, :total_copies, :available_copies, :wait_list_size)
+end

data/lib/franklin/availability_description.rb

@@ -0,0 +1,25 @@
+module Franklin
+  class AvailabilityDescription < SimpleDelegator
+    def to_s
+      "#{copies_information} @ #{library.name}"
+    end
+
+    private
+
+    def copies_information
+      available? ? "Available" : "#{copies_per_person} people/copy"
+    end
+
+    def available?
+      available_copies > 0
+    end
+
+    def copies_per_person
+      wait_list_size? ? (wait_list_size.to_f / total_copies.to_f).round(1) : "Unknown"
+    end
+
+    def wait_list_size?
+      wait_list_size > 0
+    end
+  end
+end

data/lib/franklin/collate.rb

@@ -0,0 +1,12 @@
+require "set"
+
+module Franklin
+  class Collate
+    def perform(search_results)
+      items = Set.new(search_results.flat_map(&:keys))
+      items.each_with_object({}) { |item, collation|
+        collation[item] = search_results.map { |result| result[item] }.compact
+      }
+    end
+  end
+end

data/lib/franklin/config.rb

@@ -0,0 +1,25 @@
+require_relative "library"
+require "yaml"
+
+module Franklin
+  class Config
+    DEFAULT_CONFIG_FILE = File.join(Dir.home, ".franklin").freeze
+    attr_reader :libraries
+
+    def initialize(data)
+      @libraries = data.fetch(:libraries).map { |library|
+        Library.new(library.fetch(:name), library.fetch(:url))
+      }
+    end
+
+    class << self
+      def from_yaml(yaml)
+        new(YAML.load(yaml))
+      end
+
+      def load_from_file(file_path = nil)
+        from_yaml(File.read(file_path || DEFAULT_CONFIG_FILE))
+      end
+    end
+  end
+end

data/lib/franklin/console_report.rb

@@ -0,0 +1,37 @@
+require "erb"
+require "franklin/availability_description"
+
+module Franklin
+  class ConsoleReport
+    def initialize(search_terms, collated_results)
+      @search_terms = search_terms
+      @collated_results = collated_results
+    end
+
+    def print_to_out(io)
+      io.tap { |out|
+        out.puts template.result(binding)
+      }
+    end
+
+    private
+
+    attr_reader :search_terms, :collated_results
+
+    def template
+      @template ||= ERB.new(template_source_file, safe_level, trim_value)
+    end
+
+    def template_source_file
+      File.read(File.join(__dir__, "templates", "console_report.erb"))
+    end
+
+    def safe_level
+      nil
+    end
+
+    def trim_value
+      "-"
+    end
+  end
+end

data/lib/franklin/item.rb

@@ -0,0 +1,3 @@
+module Franklin
+  Item = Struct.new(:id, :title, :author, :format)
+end

data/lib/franklin/library.rb

@@ -0,0 +1,3 @@
+module Franklin
+  Library = Struct.new(:name, :url)
+end

data/lib/franklin/search.rb

@@ -0,0 +1,58 @@
+require "franklin/item"
+require "franklin/availability"
+require "mechanize"
+
+module Franklin
+  class Search
+    def initialize(library)
+      @library = library
+    end
+
+    def perform(search_term)
+      results = search_library(search_term)
+      parse_results(results)
+    end
+
+    private
+
+    attr_reader :library
+
+    def search_library(search_term)
+      form = prepare_form(search_term)
+      form.submit
+    end
+
+    def prepare_form(search_term)
+      ::Mechanize.new.get(library.url).forms.first.tap { |form|
+        form.FullTextCriteria = search_term
+      }
+    end
+
+    def parse_results(results)
+      results.search("div.containAll").each_with_object({}) { |container, result|
+        result[parse_item(container)] = parse_availability(container)
+      }
+    end
+
+    def parse_item(container)
+      item_info = container.css("a.share-links").first.attributes
+      id = item_info["data-sharecrid"].value
+      title = item_info["data-sharetitle"].value
+      author = item_info["data-sharecreator"].value
+
+      format = container.css("span.tcc-icon-span").first.attributes["data-iconformat"].value
+
+      Item.new(id, title, author, format)
+    end
+
+    def parse_availability(container)
+      copies_info = container.css("div.img-and-info-contain.title-data").first.attributes
+
+      total_copies = copies_info["data-copiestotal"].value.to_i
+      available_copies = copies_info["data-copiesavail"].value.to_i
+      wait_list_size = copies_info["data-numwaiting"].value.to_i
+
+      Availability.new(library, total_copies, available_copies, wait_list_size)
+    end
+  end
+end

data/lib/franklin/templates/console_report.erb

@@ -0,0 +1,11 @@
+Searched for: <%= search_terms %>
+<% collated_results.each do |item, availabilities| -%>
+======================================================
+<%= item.title %>
+By <%= item.author %>
+Format: <%= item.format %>
+Availability:
+<% availabilities.each do |availability| -%>
+  <%= AvailabilityDescription.new(availability) %>
+<% end -%>
+<% end -%>

data/lib/franklin/threaded_search.rb

@@ -0,0 +1,19 @@
+require "franklin/search"
+require "franklin/collate"
+
+module Franklin
+  class ThreadedSearch
+    attr_accessor :searchers
+
+    def initialize(libraries)
+      @searchers = libraries.map { |library| Search.new(library) }
+    end
+
+    def perform(search_terms)
+      fail ArgumentError, "Please provide at least one search_term" if search_terms.empty?
+      threads = searchers.map { |search| Thread.new { search.perform(search_terms) } }
+      threads.join
+      Collate.new.perform(threads.map(&:value))
+    end
+  end
+end

data/lib/franklin/version.rb

@@ -0,0 +1,3 @@
+module Franklin
+  VERSION = "0.1.0"
+end

data/lib/franklin.rb

@@ -0,0 +1,14 @@
+require "franklin/version"
+require "franklin/config"
+require "franklin/threaded_search"
+require "franklin/console_report"
+
+module Franklin
+  def run(config_path, search_terms, out)
+    config = Config.load_from_file(config_path)
+    results = ThreadedSearch.new(config.libraries).perform(search_terms)
+    ConsoleReport.new(search_terms, results).print_to_out(out)
+  end
+
+  module_function :run
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: franklin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ylan Segal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+description: 
+email:
+- ylan@segal-family.com
+executables:
+- franklin
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/franklin
+- franklin.gemspec
+- lib/franklin.rb
+- lib/franklin/availability.rb
+- lib/franklin/availability_description.rb
+- lib/franklin/collate.rb
+- lib/franklin/config.rb
+- lib/franklin/console_report.rb
+- lib/franklin/item.rb
+- lib/franklin/library.rb
+- lib/franklin/search.rb
+- lib/franklin/templates/console_report.erb
+- lib/franklin/threaded_search.rb
+- lib/franklin/version.rb
+homepage: https://github.com/ylansegal/franklin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: CLI utility for searching Overdrive-powered public libraries
+test_files: []