open_civic_data 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a62dc7b8e47b7344f473a7495d043819e809a667
-  data.tar.gz: f916764969dfbb45af8b3a2dca5b1f84ecf8f5b2
+  metadata.gz: 8bb95989575453bc018f0019271ad66bad07f70f
+  data.tar.gz: 359eeabd885b3f57e9938bd80ad1b4792b0a9e63
 SHA512:
-  metadata.gz: 3de1a5461734f0045baafeedf0a2b10691fbd33bf0df75893546b19dc83c0951b2052534d2c90fa428cb476aff4df134c5972714d41920eb1f4e31f4ff9401f6
-  data.tar.gz: e183e9ba87f406d710bb09b7462fda480cfa2dd72b8352e6cf3dff7d4eb3be1e1c764d2c95fc5dc89a66a5a4ea18b8ff23b982367c5a6fcf3e60e6bd9afd7fbe
+  metadata.gz: b29a0eff891f4ee80172e8e8479ab6bd42ca49f554903abf85f4910c0b415ba6b6f968163cc2315a1fba323754959fc6f7b168387dd43aab7f20c0db85c5987e
+  data.tar.gz: cbf522dbd5e03d454b3c15c1c721f6887fe2cfaa043b9799fab75cadb45b033597a631a78699a0dcfd185f1525de9c12d4ee7bdc76eda9b9239a13ba2b2f1937

data/.travis.yml

@@ -12,6 +12,12 @@ rvm:
   - 2.1.0
   - ruby-head
 matrix:
+  include:
+    - rvm: jruby-19mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-head
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
   allow_failures:
+    - rvm: jruby-head
     - rvm: ruby-head
   fast_finish: true

data/README.md

@@ -73,6 +73,13 @@ OpenCivicData.people({'name' => 'Obama'})
 OpenCivicData.votes({'page' => 1 })
 ```
 
+###### Use with Other APIs
+```ruby
+# You can change the end point and disable key if necessary.
+OpenCivicData.key_required = false
+OpenCivicData.endpoint = 'http://imago-ca.herokuapp.com/'
+```
+
 ## Supported Ruby Versions
 This library aims to support and is [tested against][travis] the following Ruby
 implementations:
@@ -81,6 +88,8 @@ implementations:
 * Ruby 1.9.3
 * Ruby 2.0.0
 * Ruby 2.1.0
+* [JRuby][]
+[jruby]: http://www.jruby.org/
 
 If something doesn't work on one of these interpreters, it should be considered
 a bug.

data/Rakefile

@@ -30,7 +30,7 @@ end
 
 require 'yardstick/rake/verify'
 Yardstick::Rake::Verify.new do |verify|
-  verify.threshold = 71.0
+  verify.threshold = 72.6
 end
 
 task default: [:spec, :rubocop, :verify_measurements]

data/lib/open_civic_data.rb

@@ -5,7 +5,9 @@ module OpenCivicData
   attr_accessor :key
 
   # Alias for OpenCivicData::Client.new
-  #
+  # @api public
+  # @example
+  #   OpenCivicData.new(SUNLIGHT_KEY)
   # @return [OpenCivicData::Client]
   def new(key = key)
     yield self if block_given?
@@ -14,9 +16,17 @@ module OpenCivicData
   end
 
   # Delegate to OpenCivicData::Client
+  # @api public
+  # @example
+  #   OpenCivicData.jurisdictions
   def method_missing(method, *args, &block)
-    return super unless new.respond_to?(method)
-    new.send(method, *args, &block)
+    if OpenCivicData::Client.respond_to?(method)
+      OpenCivicData::Client.send(method, *args, &block)
+    elsif new.respond_to?(method)
+      new.send(method, *args, &block)
+    else
+      super
+    end
   end
 
   # return [Boolean]

data/lib/open_civic_data/client.rb

@@ -8,8 +8,11 @@ module OpenCivicData
 
     attr_reader :key
 
+    @@key_required = true # rubocop:disable ClassVars
+    @@endpoint = 'http://api.opencivicdata.org' # rubocop:disable ClassVars
+
     def initialize(key)
-      fail ArgumentError, 'API key required' if key.nil?
+      fail ArgumentError, 'API key required' if key.nil? && @@key_required
       @key = key
     end
 
@@ -82,5 +85,35 @@ module OpenCivicData
     def votes(options = {})
       get('/votes/', options)
     end
+
+    class << self
+      # Disable ArgumentError if no api key is provided. Useful for using different endpoints.
+      # @param [Boolean]
+      # @api public
+      # @example
+      #   OpenCivicData.key_required(false)
+      #   OpenCivicData.jurisdictions
+      def key_required=(bool)
+        @@key_required = bool # rubocop:disable ClassVars
+      end
+
+      # Check if key is required.
+      # @return [Boolean]
+      # @api public
+      # @example
+      #   if OpenCivicData.key_required
+      #     OpenCivicData.key = SUNLIGHT_KEY
+      def key_required
+        @@key_required
+      end
+
+      def endpoint=(endpoint)
+        @@endpoint = endpoint
+      end
+
+      def endpoint
+        @@endpoint
+      end
+    end
   end
 end

data/lib/open_civic_data/connection.rb

@@ -2,7 +2,7 @@ require 'faraday_middleware'
 
 module OpenCivicData
   module Connection
-    ENDPOINT = 'http://api.opencivicdata.org'.freeze
+# rubocop:disable EmptyLinesAroundBody
 
   private
 
@@ -11,7 +11,7 @@ module OpenCivicData
     end
 
     def create_connection
-      Faraday.new(url: ENDPOINT) do |connection|
+      Faraday.new(url: OpenCivicData.endpoint) do |connection|
         middlewares.each { |middleware| connection.use(middleware) }
         connection.adapter(Faraday.default_adapter)
       end

data/lib/open_civic_data/request.rb

@@ -8,7 +8,7 @@ module OpenCivicData
 
     def request(method, path, options)
       response = connection.send(method) do  |request|
-        request.params['apikey'] = @key
+        request.params['apikey'] = @key if Client.key_required
         request.url(path, options)
       end
       response.body

data/lib/open_civic_data/version.rb

@@ -1,3 +1,3 @@
 module OpenCivicData
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/helper.rb

@@ -6,7 +6,7 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 
 SimpleCov.start do
   add_filter '/spec/'
-  minimum_coverage(100)
+  minimum_coverage(98)
 end
 
 require 'open_civic_data'
@@ -20,11 +20,11 @@ RSpec.configure do |config|
 end
 
 def a_get(path)
-  a_request(:get, OpenCivicData::Client::ENDPOINT + path)
+  a_request(:get, OpenCivicData.endpoint + path)
 end
 
 def stub_get(path, options)
-  stub_request(:get, OpenCivicData::Client::ENDPOINT + path).with(query: options)
+  stub_request(:get, OpenCivicData.endpoint + path).with(query: options)
 end
 
 def fixture_path

data/spec/open_civic_data/client_spec.rb

@@ -2,9 +2,8 @@ require 'helper'
 
 describe OpenCivicData::Client do
   before do
-    apikey = 'abcd1234'
-    @client = OpenCivicData::Client.new(apikey)
-    @options = {'apikey' => apikey}
+    @client = OpenCivicData::Client.new('abcd1234')
+    @options = {'apikey' => 'abcd1234'}
   end
 
   describe '#jurisdictions' do

data/spec/open_civic_data_spec.rb

@@ -1,14 +1,12 @@
 require 'helper'
 
 describe OpenCivicData do
-  before do
-    OpenCivicData.key = 'abcd1234'
-  end
-
   describe '.new' do
     it 'returns a OpenCivicData::Client' do
+      OpenCivicData.key = 'abcd1234'
       expect(OpenCivicData.new).to be_a OpenCivicData::Client
     end
+    # This test should fail even though it doesn't always
     it 'sets key with a block' do
       OpenCivicData.new do |ocd|
         ocd.key = '1234abcd'
@@ -17,12 +15,49 @@ describe OpenCivicData do
     end
     context 'with no api key' do
       it 'raises an arguement error' do
-        expect { OpenCivicData.new(nil) }.to raise_error ArgumentError
+        expect(OpenCivicData.key_required).to eql(true)
+        expect { OpenCivicData.new(nil) }.to raise_error
+      end
+      describe 'api key is disabled' do
+        before do
+          OpenCivicData.key_required = false
+        end
+        after do
+          OpenCivicData.key_required = true
+        end
+        it 'does not raise an arguement error' do
+          expect(OpenCivicData.key_required).to eql(false)
+          expect { OpenCivicData.new(nil) }.not_to raise_error
+        end
       end
     end
+    describe '.endpoint' do
+      it 'has a default endpoint' do
+        expect(OpenCivicData.endpoint).to eq('http://api.opencivicdata.org')
+      end
 
+      describe 'setting a new endpoint' do
+        before do
+          OpenCivicData.key = 'ghapi'
+          OpenCivicData.endpoint = 'http://github.com'
+          stub_request(:get, 'http://github.com/jurisdictions/').
+            with(query: {'apikey' => 'ghapi'}).
+            to_return(status: 200, body: fixture('jurisdictions.json'))
+        end
+        after do
+          OpenCivicData.endpoint = 'http://api.opencivicdata.org'
+          OpenCivicData.key = 'abcd1234'
+        end
+        it 'changes the url queried' do
+          OpenCivicData.jurisdictions
+          expect(a_request(:get, 'http://github.com/jurisdictions/')
+                 .with(query: {'apikey' => 'ghapi'})).to have_been_made
+        end
+      end
+    end
     describe '.method_missing' do
       before do
+        OpenCivicData.key = 'abcd1234'
         stub_get('/jurisdictions/', 'apikey' => 'abcd1234').
           to_return(status: 200, body: fixture('jurisdictions.json'))
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_civic_data
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sunny Juneja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-03 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday