papertime_client 0.0.3

data/lib/papertime_client.rb

@@ -0,0 +1,108 @@
+require 'httpclient'
+require 'json'
+require 'uri'
+
+# Use by creating a client given the domain where papertime is to be found
+# e.g. client = PapertimeClient.new('http://localhost:3001')
+#
+# then making requests like so:
+#
+# client.get_publication_dates(:domain => 'op.no', :production_days => 6)
+# client.get_deadline_date(:domain => 'amta.no', :publication_date => Date.today+9, :production_days => 4)
+
+
+class PapertimeClient
+  def initialize(domain)
+    @base_uri = URI.parse(domain)+'api/v1/'
+  end
+
+  def base_url
+    return @base_uri.to_s
+  end
+  
+  def host_from_url(url)
+    return unless url
+    host = URI.parse(url).host
+    host ||= url
+    host.gsub('www.', '')
+  end
+  
+  # Get all viable publication dates after today given a required processing time 
+  # of :production_days for the publication identified with the :domain
+  # e.g. client.get_publication_dates(:domain => 'op.no', :production_days => 6)
+  # returns a hash with the single key 'issues' which points to an array of Date-objects
+  def get_publication_dates(params)
+    params[:domain] = host_from_url(params[:domain])
+    uri = @base_uri+'publication_dates'
+    uri.query = "domain=#{params[:domain]}&production_days=#{params[:production_days]}"
+    result = content_from(uri)
+    result['issues'] = result['issues'].map{|date| Date.parse(date)}
+    result
+  end
+  
+  # Compute the deadline for publication on :publication_date given a processing time
+  # of :production_days for the publication identified with the :domain
+  # e.g. client.get_deadline_date(:domain => 'amta.no', :publication_date => Date.today+9, :production_days => 4)
+  # returns the Date
+  def get_deadline_date(params)
+    params[:domain] = host_from_url(params[:domain])
+    uri = @base_uri+'deadline_date'
+    uri.query = "domain=#{params[:domain]}&publication_date=#{params[:publication_date]}&production_days=#{params[:production_days]}"
+    result = content_from(uri)
+    return Date.parse(result['deadline']) if result['deadline']
+    result    
+  end
+  
+  # Compute the nearest possible publication date from a :domain and :desired_publication_date
+  # e.g. client.get_nearest_publication_date(:domain => 'amta.no', :desired_publication_date => Date.today+9)
+  # returns the Date
+  def get_nearest_publication_date(params = {})
+    raise ArgumentError, "Cannot retrieve publication date without domain" unless params[:domain]
+    raise ArgumentError, "Cannot retrieve publication date without desired publication date" unless params[:desired_publication_date]
+    domain = host_from_url(params[:domain])
+    uri = @base_uri + 'nearest_publication_date'
+    uri.query = "domain=#{domain}&desired_publication_date=#{params[:desired_publication_date]}"
+    result = content_from(uri)    
+    return if result.nil?
+    return Date.parse(result['publication_date']) if result['publication_date']
+    result
+  end
+
+  def find_publication_by_domain(domain)
+    raise ArgumentError, "Cannot retrieve publication without domain" unless domain
+    domain = host_from_url(domain)
+    uri = @base_uri + 'find_publication_by_domain'
+    uri.query = "domain=#{domain}"
+    content_from(uri)
+  end
+
+  def find_publications_by_lat_lon(lat,lon)
+    raise ArgumentError, "Cannot retrieve publications without lat/lon" unless (lat and lon)
+    uri = @base_uri + 'find_publications_by_lat_lon'
+    uri.query = "lat=#{lat}&lon=#{lon}"
+    content_from(uri)
+  end
+
+  def coverage_areas
+    uri = @base_uri + 'coverage_areas.json'
+    content_from(uri)
+  end
+  
+  private
+  
+  def content_from(uri)
+    begin
+      client = HTTPClient.new.get_content(uri)
+      return JSON.parse(client)
+    rescue Errno::ECONNREFUSED => e
+      puts("Could not connect to papertime server: #{e.message}")
+      puts e.inspect
+      puts e.backtrace
+    rescue Exception => e
+      puts("Something went wrong while calling papertime api: #{e.message}")
+      puts e.inspect
+      puts e.backtrace
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: papertime_client
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Origogruppen AS
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: &70130659978060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70130659978060
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70130659977060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70130659977060
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70130659975100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70130659975100
+description: Papertime is a server giving details about Norwegian newspapers. This
+  is a client for connecting to that server.
+email: post@origo.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/papertime_client.rb
+homepage: https://github.com/origo/papertime_client
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: For talking to Papertime server
+test_files: []