archivist-client 0.1.0 → 0.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTNjMjQ1ZTA3M2RkNzA3NzA0MDg1ZjY2MmMwMzYwODYzYzM1ZTZhMA==
+    OGMwNzNlM2QxMTcwZjFlMzlmNTBjMGJlODY3YTdkM2M4MTU2YzViYw==
   data.tar.gz: !binary |-
-    ZGYzZGU5NjBlNzI4NGNkZGM4NmVkNWU1NjY0NTM3OGRhM2ZhYjM4OQ==
+    Y2RiZjY3Njg4NjIzODQyMmJlZTQ5NDQ3OWNlZDE4YjY4NzBlNmFkZg==
 SHA512:
   metadata.gz: !binary |-
-    MDQ4YzFhNzM2YjE2YjdhYmU1YTU2MzJlZDE4Nzc4NDM0YmJlZWUyYTI1OTdj
-    ZTUwNzk0MmUyOTdmMjRjMjYzZmVmMDM0NjhiZjA5ZDc4NmMyNzQ5YzdiM2Nh
-    NmZhNDVjYTQyNjQ3YjI4MzQ4ZmE0YTY4ZjRjOGNkZTU2MjFjYmU=
+    MDJjNmVjZTNmZWQ2YzBjNjMxNDRiNTFlMjRkMmEyZDcwMzFlMDM3NGIyZjU2
+    NGZhNGNmMzI4NWNkMGFlMjI0YmJlYjE3MTVlNzJlMDQ1MTE1OGVlNjYzOGZi
+    MDhjOTAwM2Y2ZmFmMTJkZDAwZDM4ZjdiYTdiOWJhMmU0Mzk3YTY=
   data.tar.gz: !binary |-
-    NGYzZmVmNTY2ZmEzZDM0NGI0OTJhOTNmZWUyNjViYTk3MGI1NzgxMWYxNTI1
-    NTU0YWE1YjJhYzgxOTY3ZDcyNzFiZWMxZGI5ZDZkNDJjM2Y1YmRiNmY0MTZh
-    M2M5M2EzZWNiZjNiNTlkMzkxNDBlYzU2ZTBmN2EyNDY2NWJlYWQ=
+    NzU3MzQ1NDFkNGJiZGMyNWQ4NmYxMDAwMGM2MTBjYTg5NjY0OGYzYTc1MTE5
+    YmFkNjFlMjZmZjhlNTQ4Mjk2NjU1ZjkwNTAwNTQ4Mzc3Mzk1YmYxOTA1NTcw
+    MDE5YTQ4YjcxZTQwMmI0NGJjZTgyZjY1NDdmMzY3NzFiYTg3ZjQ=

data/archivist-client.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "vcr"
   gem.add_development_dependency "reek", ">= 1.2.8"
   gem.add_development_dependency "roodi", ">= 2.1.0"
+  gem.add_development_dependency "gem-release", ">= 0.7.1"
 
   gem.add_dependency "virtus", "~> 1.0.0"
   gem.add_dependency "representable"

data/lib/archivist/client/base.rb

@@ -1,46 +1,56 @@
 require 'faraday'
 require 'faraday_middleware'
+require 'archivist/client/filters'
 require 'archivist/representations'
 
 module Archivist
   module Client
+    # This is the primary interface of the gem.
+    # Example Usage:
+    #   require 'archive-client'
+    #   # Create an Archivist client:
+    #   client = Archivist::Client::Base.new
+    #   # Search for the books you're interested in:
+    #   books = client.search(:start_year => 1500, :end_year => 1510)
+    #   # Download them:
+    #   books.each do |book|
+    #     puts book.download
+    #   end
     class Base
+      DEFAULT_CONNECTION = Faraday.new(url: 'http://archive.org') do |faraday|
+        faraday.use FaradayMiddleware::FollowRedirects
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
       attr_reader :conn
+      attr_accessor :filters # will be a Filters.new object
 
-      def initialize(opts = {})
+      # filter_opts can be provided here, or when search is called.
+      # filters_opts are:
+      #   :language   => if *any* search opts provided there.
+      #   :start_year => search opts takes precedence when provided there.
+      def initialize(opts = {}, filter_opts = {})
+        @filters = Archivist::Client::Filters.new(filter_opts)
         @opts = {
           page: 1,
           rows: 50
         }.merge(opts)
 
-        @conn = Faraday.new(url: 'http://archive.org') do |faraday|
-          faraday.use FaradayMiddleware::FollowRedirects
-          faraday.request  :url_encoded             # form-encode POST params
-          faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
-        end
+        @conn = DEFAULT_CONNECTION
       end
 
-      def query(opts)
-        filters = [
-          'mediatype:texts',
-          '-mediatype:collection'
-        ]
-
-        filters.concat(opts.delete(:filters)) if opts[:filters]
-
-        filters << if opts[:language]
-          "language:#{opts.delete(:language)}"
-        else
-          '(language:eng OR language:English)'
+      def search(opts = {})
+        Model::QueryResponse.new.tap do |qr|
+          response = @conn.get('/advancedsearch.php', params(opts))
+          Representation::QueryResponse.new(qr).from_json(response.body)
         end
+      end
 
-        if opts[:start_year] && opts[:end_year]
-          start_year = "#{opts.delete(:start_year)}-01-01"
-          end_year = "#{opts.delete(:end_year)}-12-31"
-          filters << "date:[#{start_year} TO #{end_year}]"
-        end
+      private
 
-        filters.join(' AND ')
+      def query(opts)
+        @filters.update!(opts)
+        @filters.to_query
       end
 
       def params(opts = {})
@@ -52,12 +62,6 @@ module Archivist
         }.merge(@opts).merge(opts)
       end
 
-      def search(opts = {})
-        Model::QueryResponse.new.tap do |qr|
-          response = @conn.get('/advancedsearch.php', params(opts))
-          Representation::QueryResponse.new(qr).from_json(response.body)
-        end
-      end
     end
   end
 end

data/lib/archivist/client/filters.rb

@@ -0,0 +1,104 @@
+module Archivist
+  module Client
+    # Filters class manages the available filters that are configured to work with Archive.org
+    # The public API is very simple, and is used to create Archive.org query strings:
+    #   filters = Filters.new(options)
+    #   query = filters.to_query
+    class Filters
+
+      # When Filters Provided are impossible try to Fail well.
+      class FilterException < StandardError; end
+
+      STANDARD_OPTIONS = [
+        :filters,
+        :language,
+        :start_year, :end_year
+      ]
+      DEFAULT_FILTERS = [
+        'mediatype:texts',
+        '-mediatype:collection'
+      ]
+
+      attr_accessor :options,
+                    :filters,
+                    :language,
+                    :start_year, :end_year
+
+      def initialize(opts)
+        @options = {}
+        self.update!(opts)
+      end
+
+      def update!(opts)
+        self.prune_options!(opts)
+        self.set_language!
+        self.set_years!
+        self.set_filters!
+      end
+
+      # May result in a URI with filters looking like:
+      #   http://archive.org/advancedsearch.php?fl%5B0%5D=identifier&fl%5B1%5D=title&fl%5B2%5D=creator&fl%5B3%5D=date&fl%5B4%5D=language&fl%5B5%5D=mediattype&output=json&page=1&q=mediatype:texts%20AND%20-mediatype:collection%20AND%20(language:eng%20OR%20language:English)%20AND%20date:%5B1500-01-01%20TO%201550-12-31%5D&rows=50&sort%5B0%5D=date%20asc
+      alias :to_query :to_s
+      def to_query
+        self.finalize_filters!
+        @filters.join(' AND ')
+      end
+
+      protected
+
+      def prune_options!(opts)
+        # Save the options we need to build the filter
+        @options.merge!(opts)
+        # Remove the options used from the passed in options, so they don't get converted into parameters
+        STANDARD_OPTIONS.each do |opt|
+          opts.delete(opt)
+        end
+      end
+
+      # Only overwrite if update! options has language key
+      def set_language!
+        @language = @options[:language] if @options.has_key?(:language)
+      end
+
+      def set_years!
+        start = @options[:start_year]
+        finish = @options[:end_year]
+        @start_year = "#{start}-01-01" if start
+        @end_year = "#{finish}-12-31" if finish
+        self.validate_years!
+      end
+
+      # If one is provided, they must *both* be provided
+      def validate_years!
+        unless @start_year && @end_year
+          raise FilterException, ":start_year and :end_year must always be provided together, but only :start_year provided as #{@start_year}." if @start_year
+          raise FilterException, ":start_year and :end_year must always be provided together, but only :end_year provided as #{@end_year}." if @end_year
+        end
+        return true
+      end
+
+      def set_filters!
+        @filters = Array(@options[:filters]) # If opts[:filters] is nil => self.array is []
+        @filters |= DEFAULT_FILTERS
+      end
+
+      def add_language_filter!
+        @filters << if @language
+                          "language:#{@language}"
+                        else
+                          '(language:eng OR language:English)'
+                        end
+      end
+
+      def add_date_filter!
+        @filters << "date:[#{@start_year} TO #{@end_year}]"
+      end
+
+      def finalize_filters!
+        self.add_language_filter!
+        self.add_date_filter!
+        self
+      end
+    end
+  end
+end

data/lib/archivist/client/version.rb

@@ -1,5 +1,5 @@
 module Archivist
   module Client
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/lib/archivist/models/document.rb

@@ -1,3 +1,5 @@
+require 'faraday'
+require 'faraday_middleware'
 require 'virtus'
 require 'date'
 
@@ -5,6 +7,13 @@ module Archivist
   module Model
     class Document
       include Virtus.model
+      DEFAULT_CONNECTION = Faraday.new(url: 'http://archive.org') do |faraday|
+        faraday.use FaradayMiddleware::FollowRedirects
+        # faraday.response :logger                  # log requests to STDOUT
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+      attr_reader :conn
 
       attribute :identifier, String
       attribute :title, String
@@ -13,12 +22,7 @@ module Archivist
       attribute :creators, Array[String]
 
       def initialize
-        @conn = Faraday.new(url: "http://archive.org") do |faraday|
-          faraday.use FaradayMiddleware::FollowRedirects
-          faraday.request  :url_encoded             # form-encode POST params
-          # faraday.response :logger                  # log requests to STDOUT
-          faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
-        end
+        @conn = DEFAULT_CONNECTION
       end
 
       def format_index

data/lib/archivist/models/format_index.rb

@@ -8,7 +8,7 @@ module Archivist
       attribute :formats
 
       def find(key)
-        formats.find{ |f| f.format == key }
+        formats.find{ |value| value.format == key }
       end
       alias_method :[], :find
 
@@ -17,4 +17,4 @@ module Archivist
       end
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: archivist-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Duane Johnson
@@ -123,6 +123,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +205,7 @@ files:
 - archivist-client.gemspec
 - README.md
 - lib/archivist/client/base.rb
+- lib/archivist/client/filters.rb
 - lib/archivist/client/version.rb
 - lib/archivist/models/body.rb
 - lib/archivist/models/document.rb