franklin 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b7efde29c026dbc795cbe81417a627ef35ca556
-  data.tar.gz: 71cc18d43c0e669942f9133e2326ee66b3060279
+  metadata.gz: a7bee880c35d71a839754345afcad98f0cc58ce3
+  data.tar.gz: bbda755d21be8278a41cce095f786a1015c05389
 SHA512:
-  metadata.gz: 46bd872e98f7190a6e3cf69bffad1acbd49e816a2ea58e1f8e51d681b850030aa92c4702f26c59fb90f87098208f8f1b504437e7f07d243a463b3d8656501bb2
-  data.tar.gz: 2788cc2a039330ea05d811028266d67754d3dc9d306f1b0570a96c9d003ce38781d14c0052462629c6a89152d0603c1ebdf5d60d85fc4330e4b25824e3802fa9
+  metadata.gz: 507396aba4b52f6a973a78731bb071453d102f94aa10ba3c1c1d382fc8ef714d93f5095cdedadfe02aa4f286010d038b77e8b0d213f6f18f39f53c1294e00574
+  data.tar.gz: 4d13e4c433b4478bc437d83e2d36e3f781522c6befcc7ec0e0da2fcb33d0f8381bfe68587922b2f2f3128257f6cba97614e1ff145088974e083d3dd006c4e77f

data/README.md

@@ -19,9 +19,10 @@ Franklin needs to be configured with information about the Overdrive libraries i
     :url: http://sfpl.lib.overdrive.com
   - :name: San Diego Public Library
     :url: http://sdpl.lib.overdrive.com
+:default_type: eBook # Optional, will show all types if not set.
 ```
 
-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.
+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 stripping everything after the domain name.
 
 ## Usage
 
@@ -69,6 +70,10 @@ Availability:
   Available @ San Diego County Library
 ```
 
+Franklin supports using a different path for the configuration file and filtering results by type (ie,  eBook, Audiobook, etc).
+
+See `franklin --help` for more information.
+
 ## 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.

data/exe/franklin

@@ -1,13 +1,34 @@
 #!/usr/bin/env ruby
-
 require "franklin"
+require "optparse"
+
+options = { out: STDOUT, config_path: Franklin::Config::DEFAULT_CONFIG_FILE }
+parser = OptionParser.new { |opts|
+  opts.banner = "Usage: frankling [options] search_term1 search_term2..."
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    puts "Franklin v#{Franklin::VERSION}"
+    exit
+  end
+
+  opts.on("--config-path=CONFIG", "Path to configuration file. Defaults to ~/.franklin") do |config_path|
+    options[:config_path] = config_path
+  end
+
+  opts.on "-tTYPE", "--type=TYPE", "Filter results by type (eBook, Audiobook, etc). Will override config" do |type|
+    options[:type] = type
+  end
+}
+
+parser.parse!
 
 begin
-  Franklin.run(nil, ARGV.join(" "), STDOUT)
+  Franklin.run(ARGV.join(" "), options)
 rescue ArgumentError => ex
   puts <<-ERROR.gsub(/^  /, "")
-  Oops! #{ex.message}"
-  Usage: franklin search_term [other_term..]"
+  Oops! #{ex.message}
+  #{parser}
   ERROR
 rescue Errno::ENOENT
   puts <<-ERROR.gsub(/^  /, "")
@@ -19,5 +40,6 @@ rescue Errno::ENOENT
       :url: http://sfpl.lib.overdrive.com
     - :name: San Diego Public Library
       :url: http://sdpl.lib.overdrive.com
+  :default_type: eBook # Optional, leave empty to search for all types
   ERROR
 end

data/lib/franklin/config.rb

@@ -4,12 +4,13 @@ require "yaml"
 module Franklin
   class Config
     DEFAULT_CONFIG_FILE = File.join(Dir.home, ".franklin").freeze
-    attr_reader :libraries
+    attr_reader :libraries, :default_type
 
     def initialize(data)
       @libraries = data.fetch(:libraries).map { |library|
         Library.new(library.fetch(:name), library.fetch(:url))
       }
+      @default_type = data[:default_type]
     end
 
     class << self

data/lib/franklin/type_filter.rb

@@ -0,0 +1,16 @@
+module Franklin
+  class TypeFilter
+    def initialize(type)
+      @type = type
+    end
+
+    def perform(results)
+      return results unless type
+      results.dup.keep_if { |item, _availability| item.format.casecmp(type) == 0 }
+    end
+
+    private
+
+    attr_reader :type
+  end
+end

data/lib/franklin/version.rb

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

data/lib/franklin.rb

@@ -1,13 +1,15 @@
 require "franklin/version"
 require "franklin/config"
 require "franklin/threaded_search"
+require "franklin/type_filter"
 require "franklin/console_report"
 
 module Franklin
-  def run(config_path, search_terms, out)
-    config = Config.load_from_file(config_path)
+  def run(search_terms, opts)
+    config = Config.load_from_file(opts[:config_path])
     results = ThreadedSearch.new(config.libraries).perform(search_terms)
-    ConsoleReport.new(search_terms, results).print_to_out(out)
+    filtered_results = TypeFilter.new(opts[:type] || config.default_type).perform(results)
+    ConsoleReport.new(search_terms, filtered_results).print_to_out(opts[:out])
   end
 
   module_function :run

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: franklin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ylan Segal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2016-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -137,6 +137,7 @@ files:
 - lib/franklin/search.rb
 - lib/franklin/templates/console_report.erb
 - lib/franklin/threaded_search.rb
+- lib/franklin/type_filter.rb
 - lib/franklin/version.rb
 homepage: https://github.com/ylansegal/franklin
 licenses:
@@ -158,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: CLI utility for searching Overdrive-powered public libraries