pillboxr 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 653e105fbd4add221d54abb8c3e6e8e55d780e97
-  data.tar.gz: 3f6c9a7b8714690398950179823d5d5790ff57f6
+  metadata.gz: dfea71f63f4e797781867df304d09cf34eebaf84
+  data.tar.gz: 63f2c31b307acec4c62b585557853ae55a46f266
 SHA512:
-  metadata.gz: 98f2dbdf7018202d175041a7884c49e0553f839c9e528e83a891495e50731c30eba1a556630a9abfe2228a974834539a32242d702c97f2b9d9d470005ecc9832
-  data.tar.gz: 48c43f42431f74515a826f1fd8abf77bc49539a7547486ebc4d36d792284fa9dd72007e80b1d5da0b102ff6f68cd7712c61cc042432b775e4da0f2467e4fd669
+  metadata.gz: a69d0095894eaa8d5c748338c6282891b5e91a81bf7c7344c959b7f979c49582c6aae100d3f9336bfa47585204db249e6eb766176105ae43c33094069e49c96b
+  data.tar.gz: b7a786475a570292a02b87647953ee86952d218880f36095c0cafe7144965464bab3c32ab9e968e5376b4e9dc0d69234645744ed0ac9886d7a0ad0376c99f2fb

data/.ruby-gemset

@@ -0,0 +1 @@
+pillboxr

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/README.md

@@ -1,5 +1,7 @@
 # Pillboxr
 
+[![Gem Version](https://badge.fury.io/rb/pillboxr.png)](http://badge.fury.io/rb/pillboxr)
+
 Pillboxr is a Ruby wrapper for the National Library of Medicine Pillbox API Service located at [http://pillbox.nlm.nih.gov](http://pillbox.nlm.nih.gov).
 
 The pillbox API provides information from the FDA about various prescription medications.

data/lib/pillboxr.rb

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
 
+require_relative 'pillboxr/config'
 require_relative 'pillboxr/extensions'
 require_relative 'pillboxr/result'
 require_relative 'pillboxr/pill'
@@ -7,7 +8,6 @@ require_relative 'pillboxr/params'
 require_relative 'pillboxr/request'
 
 module Pillboxr
-
   # Assign an api_key to this session.  Delegates to Request#api_key=
   # @param [String, Pathname, File, Object] the key itself, or a way to load the key, or an object that responds to the 'key' method.
   def api_key=(arg)
@@ -67,4 +67,4 @@ module Pillboxr
     klass.extend(Pillboxr::Extensions) unless klass.methods.include?(:to_constant)
     klass.to_constant.new(value)
   end
-end
+end

data/lib/pillboxr/attributes.rb

@@ -253,7 +253,7 @@ module Pillboxr
     class Lowerlimit
       attr_accessor :lower_limit
 
-      def initialize(limit = DEFAULT_LOWER_LIMIT)
+      def initialize(limit = Pillboxr.config.default_lower_limit)
         @lower_limit = case limit
         when NilClass; raise LowerLimitError
         when Integer;  limit

data/lib/pillboxr/config.rb

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+require 'singleton'
+
+module Pillboxr
+  class Config
+    include Singleton
+    
+    attr_accessor :records_per_page,
+                  :default_lower_limit,
+                  :no_records_error_message,
+                  :no_records_response,
+                  :api_key_error_message
+
+    attr_reader :base_uri
+
+    def initialize(options = {})
+      @records_per_page    = 201
+      @default_lower_limit = 1
+      @base_uri = 'pillbox.nlm.nih.gov'
+      @no_records_error_message = "The document \"No records found\" does not have a valid root"
+      @no_records_response = "No records found"
+      @api_key_error_message = "The document \"Key does not match, you may not access this service\" does not have a valid root"
+    end
+  end
+  # Global config object
+  def config
+    Config.instance
+  end
+
+  def config=(hash)
+    Config.send(:new, hash)
+  end
+    
+  module_function :config
+end
+

data/lib/pillboxr/constants.rb

@@ -1,11 +1,5 @@
 # -*- encoding: utf-8 -*-
 module Pillboxr
-    RECORDS_PER_PAGE    = 201
-    DEFAULT_LOWER_LIMIT = 1
-    BASE_URI = 'pillbox.nlm.nih.gov'
-    NO_RECORDS_ERROR_MESSAGE = "The document \"No records found\" does not have a valid root"
-    API_KEY_ERROR_MESSAGE = "The document \"Key does not match, you may not access this service\" does not have a valid root"
-
   module Attributes
     SHAPES = {
         :bullet=> :C48335,
@@ -58,4 +52,4 @@ module Pillboxr
 
     SCHEDULE_CODES = DEA_CODES.invert
   end
-end
+end

data/lib/pillboxr/params.rb

@@ -15,7 +15,7 @@ module Pillboxr
     # @param [Hash] options for which page to fetch
     def get(options = {}, &block)
       if options[:page]
-        self << Pillboxr::Attributes::Lowerlimit.new(options.fetch(:page) * RECORDS_PER_PAGE)
+        self << Pillboxr::Attributes::Lowerlimit.new(options.fetch(:page) * Pillboxr.config.records_per_page)
       end
       @module_name.send(:complete, self, &block)
     end
@@ -25,7 +25,7 @@ module Pillboxr
         limit = self.select { |param| param.respond_to?(:lower_limit) }.first.lower_limit
         return limit
       else
-        return DEFAULT_LOWER_LIMIT
+        return Pillboxr.config.default_lower_limit
       end
     end
 
@@ -38,4 +38,4 @@ module Pillboxr
       @module_name.send(:method_missing, method_name, *args)
     end
   end
-end
+end

data/lib/pillboxr/request.rb

@@ -6,18 +6,18 @@ module Pillboxr
   class Request
     include HTTParty
     format :xml
-    base_uri BASE_URI
+    base_uri Pillboxr.config.base_uri
     parser(Class.new(HTTParty::Parser) do
             def parse
               begin
                 body.gsub!(/^<disclaimer>.+<\/disclaimer>/, "")
-                body.gsub!(/\s\&\s/, ' and ')
+                body.gsub!(/\&/, '&amp;')
                 super
               rescue MultiXml::ParseError => e
-                if e.message == NO_RECORDS_ERROR_MESSAGE
+                if e.message == Pillboxr.config.no_records_error_message or body == Pillboxr.config.no_records_response
                   result = {'Pills' => {'pill' => [], 'record_count' => 0 }}
                   return result
-                elsif e.message == API_KEY_ERROR_MESSAGE
+                elsif e.message == Pillboxr.config.api_key_error_message
                   raise "Invalid api_key. Check format and try again."
                 else
                   raise
@@ -83,4 +83,4 @@ module Pillboxr
       "/PHP/pillboxAPIService.php?key=#{self.class.api_key}"
     end
   end
-end
+end

data/lib/pillboxr/result.rb

@@ -7,7 +7,7 @@ module Pillboxr
     attr_accessor :record_count, :pages
 
     def initialize(api_response, &block)
-      initial_page_number = Integer(api_response.query.params.limit / RECORDS_PER_PAGE )
+      initial_page_number = Integer(api_response.query.params.limit / Pillboxr.config.records_per_page )
       @record_count = Integer(api_response.body['Pills']['record_count'])
 
       puts "#{@record_count} records available. #{api_response.body['Pills']['pill'].size} records retrieved."
@@ -23,7 +23,7 @@ module Pillboxr
     end
 
     def self.subsequent(api_response)
-      return parse_pills(api_response, RECORDS_PER_PAGE)
+      return parse_pills(api_response, Pillboxr.config.records_per_page)
     end
 
     def self.parse_pills(api_response, record_count)
@@ -62,19 +62,19 @@ module Pillboxr
 
     def initialize_pages_array(api_response, initial_page_number)
       unless record_count == 0
-        record_count.divmod(RECORDS_PER_PAGE).tap do |ary|
+        record_count.divmod(Pillboxr.config.records_per_page).tap do |ary|
           if ary[1] == 0
             return Pages.new(ary[0]) do |i|
               page_params = api_response.query.params.dup
               page_params.delete_if { |param| param.respond_to?(:lower_limit)}
-              page_params << Attributes::Lowerlimit.new(i * RECORDS_PER_PAGE)
+              page_params << Attributes::Lowerlimit.new(i * Pillboxr.config.records_per_page)
               Page.new(i == initial_page_number, i == initial_page_number, i, [], page_params)
             end
           else
             return Pages.new(ary[0] + 1) do |i|
               page_params = api_response.query.params.dup
               page_params.delete_if { |param| param.respond_to?(:lower_limit)}
-              page_params << Attributes::Lowerlimit.new(i * RECORDS_PER_PAGE)
+              page_params << Attributes::Lowerlimit.new(i * Pillboxr.config.records_per_page)
               Page.new(i == initial_page_number, i == initial_page_number, i, [], page_params)
             end
           end
@@ -83,4 +83,4 @@ module Pillboxr
       return Pages.new(1) { |i| Page.new(true, true, i, [], api_response.query.params.dup)}
     end
   end
-end
+end

data/lib/pillboxr/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding: utf-8 -*-
 module Pillboxr
- VERSION = "0.9.0"
+ VERSION = "0.9.1"
 end

data/pillboxr.gemspec

@@ -18,7 +18,6 @@ The pillbox API provides information from the FDA about various prescription med
 *Note:* This library is designed for use with Ruby 1.9.3 and above, and will not work with earlier versions of Ruby.
 END
 
-  s.required_rubygems_version = "~> 1.8.6"
   s.rubyforge_project         = "pillboxr"
 
   s.add_dependency 'httparty', '~> 0.8.3'

data/test/pillboxr/params_test.rb

@@ -18,7 +18,7 @@ class TestParams < MiniTest::Unit::TestCase
   end
 
   def test_limit_method
-    assert_equal(Pillboxr::DEFAULT_LOWER_LIMIT, @params.limit)
+    assert_equal(Pillboxr.config.default_lower_limit, @params.limit)
     @params << Pillboxr::Attributes::Lowerlimit.new(300)
     assert_equal(300, @params.limit)
   end
@@ -45,4 +45,4 @@ class TestParams < MiniTest::Unit::TestCase
     refute_empty r
     assert_instance_of(Pillboxr::Attributes::Color, r.first)
   end
-end
+end

data/test/pillboxr/pillboxr_test.rb

@@ -195,4 +195,18 @@ class TestPillboxr < MiniTest::Unit::TestCase
       assert_equal(3, @result.pages.current.number)
     end
   end
+
+  def test_empty_record_set_response_caught
+    VCR.use_cassette(:empty_record_set) do
+      no_records_response = Pillboxr.config.no_records_response
+      Pillboxr.config.no_records_response = "foo"
+      no_records_error_message = Pillboxr.config.no_records_error_message
+      Pillboxr.config.no_records_error_message = "bar"
+      assert_raises(MultiXml::ParseError) do
+        @result = Pillboxr.with(:color => [:blue,:green], :size => 100)
+      end
+      Pillboxr.config.no_records_error_message = no_records_error_message
+      Pillboxr.config.no_records_response = no_records_response
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pillboxr
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Keith Gautreaux
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-15 00:00:00.000000000 Z
+date: 2014-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -109,13 +109,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rvmrc"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - lib/pillboxr.rb
 - lib/pillboxr/attributes.rb
+- lib/pillboxr/config.rb
 - lib/pillboxr/constants.rb
 - lib/pillboxr/extensions.rb
 - lib/pillboxr/pages.rb
@@ -147,12 +149,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.6
+      version: '0'
 requirements: []
 rubyforge_project: pillboxr
-rubygems_version: 2.2.0
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Access the NLM Pillbox API using Ruby.

data/.rvmrc

@@ -1,52 +0,0 @@
-#!/usr/bin/env bash
-
-# This is an RVM Project .rvmrc file, used to automatically load the ruby
-# development environment upon cd'ing into the directory
-
-# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
-# Only full ruby name is supported here, for short names use:
-#     echo "rvm use 2.0.0" > .rvmrc
-environment_id="ruby-2.0.0-p0@pillboxr"
-
-# Uncomment the following lines if you want to verify rvm version per project
-# rvmrc_rvm_version="1.18.18 (latest)" # 1.10.1 seams as a safe start
-# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
-#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
-#   return 1
-# }
-
-# First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficient compared to running through the entire
-# CLI and selector. If you want feedback on which environment was used then
-# insert the word 'use' after --create as this triggers verbose mode.
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
-then
-  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
-    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
-  if [[ $- == *i* ]] # check for interactive shells
-  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
-  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
-  fi
-else
-  # If the environment file has not yet been created, use the RVM CLI to select.
-  rvm --create use  "$environment_id" || {
-    echo "Failed to create RVM environment '${environment_id}'."
-    return 1
-  }
-fi
-
-# If you use bundler, this might be useful to you:
-# if [[ -s Gemfile ]] && {
-#   ! builtin command -v bundle >/dev/null ||
-#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
-# }
-# then
-#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
-#   gem install bundler
-# fi
-# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
-# then
-#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
-# fi