one_bus_away 0.0.2 → 0.0.4

data/spec/client_spec.rb

@@ -0,0 +1,210 @@
+require 'one_bus_away/client'
+
+RSpec.describe OneBusAway::Client do
+  let(:valid_client) do
+    OneBusAway::Client.new(
+      api_method: ['current-time']
+    )
+  end
+
+  let(:invalid_client) { OneBusAway::Client.new }
+
+  describe '#api_key' do
+    it 'to respond' do
+      expect(valid_client).to respond_to(:api_key)
+    end
+    it 'returns api_key' do
+      client = valid_client
+      client.api_key = 'aer-dkjfwif0d-slkjsdflkjs'
+      expect(client.api_key).to eq('aer-dkjfwif0d-slkjsdflkjs')
+    end
+
+    it 'calls apply_local_api_key' do
+      file_like_object = 'somekey'
+      allow(File).to receive(:exist?).and_return(true)
+      allow(File).to receive(:read).and_return(file_like_object)
+
+      expect(invalid_client.api_key).to eq('somekey')
+    end
+  end
+
+  describe '#apply_local_api_key' do
+    it 'responds' do
+      expect(invalid_client).to respond_to(:apply_local_api_key)
+    end
+
+    it 'fails if file does not exists' do
+      allow(File).to receive(:exist?).and_return(false)
+
+      expect { invalid_client.apply_local_api_key }
+        .to raise_error(RuntimeError, 'no API key provided. '\
+                        'Please ensure you have your api key'\
+                        'installed in here: ~/.one_bus_away'
+                       )
+    end
+    it 'succeeds if file exists' do
+      file_like_object = '123-12321321-1234jsdkfjsd'
+      allow(File).to receive(:exist?).and_return(true)
+      allow(File).to receive(:read).and_return(file_like_object)
+
+      expect(invalid_client.apply_local_api_key).to eq(file_like_object)
+    end
+  end
+
+  describe '#api_method' do
+    it 'to respond' do
+      expect(valid_client).to respond_to(:api_method)
+    end
+    it 'returns api_method' do
+      client = valid_client
+      client.api_method = ['route-ids-for-agency']
+      expect(client.api_method).to eq(['route-ids-for-agency'])
+    end
+  end
+
+  describe '#build_path' do
+    it 'responds' do
+      expect(invalid_client).to respond_to(:build_path)
+    end
+    it 'formats correctly' do
+      client = valid_client
+      client.api_method = ['route-ids-for-agency', '1']
+
+      expect(client.build_path)
+        .to eq('/api/where/route-ids-for-agency/1.json')
+    end
+  end
+
+  describe '#parameters' do
+    it 'to respond' do
+      expect(valid_client).to respond_to(:parameters)
+    end
+    it 'returns parameters' do
+      client = valid_client
+      client.parameters = { somekey: 'someparameters' }
+
+      expect(valid_client.parameters)
+        .to eq(somekey: 'someparameters')
+    end
+  end
+
+  describe '#build_query' do
+    it 'responds' do
+      expect(invalid_client).to respond_to(:build_query)
+    end
+
+    it 'contains api_key if no parameters' do
+      client = valid_client
+      client.parameters = nil
+      client.api_key = 'thisissomekeyyyyy'
+
+      expect(client.build_query).to eq('key=thisissomekeyyyyy')
+    end
+    it 'contains all parameters if included' do
+      client = valid_client
+      client.api_key = 'thisissomekeyyyyy'
+      client.parameters = {
+        route: 'someroute',
+        stop: 'somestop'
+      }
+
+      expect(client.build_query)
+        .to eq('key=thisissomekeyyyyy&route=someroute&stop=somestop')
+    end
+  end
+
+  describe '.valid?' do
+    context 'with valid paremeters' do
+      it 'is truthy' do
+        expect(valid_client.valid?).to be_truthy
+      end
+    end
+
+    context 'without valid parameters' do
+      it 'is falsey' do
+        expect(invalid_client.valid?).to be_falsey
+      end
+    end
+  end
+
+  describe '#get' do
+    it 'responds' do
+      expect(invalid_client).to respond_to(:get)
+    end
+    it 'fails if url not built' do
+      client = invalid_client
+
+      expect { client.get }
+        .to raise_error(RuntimeError, 'url is not properly built')
+    end
+  end
+
+  describe '#base_url' do
+    it 'equals the correct string' do
+      expect(invalid_client.base_url)
+        .to eq('api.pugetsound.onebusaway.org')
+    end
+  end
+
+  describe '#build_url' do
+    it { expect(invalid_client).to respond_to(:build_url) }
+
+    it 'returns correct url without parameters' do
+      client = valid_client
+      client.api_key = 'somekey'
+      client.parameters = nil
+      client.api_method = ['current_time']
+
+      expect(valid_client.build_url)
+        .to eq('http://api.pugetsound.onebusaway.org/api/where/current_time.json?key=somekey')
+    end
+
+    it 'returns correct url without parameters' do
+      client = valid_client
+      client.api_key = 'somekey'
+      client.parameters = { route: '123532' }
+      client.api_method = ['arrivals-and-departures-for-stop', '1_75403']
+
+      expect(valid_client.build_url)
+        .to eq('http://api.pugetsound.onebusaway.org'\
+        '/api/where/arrivals-and-departures-for-stop/'\
+        '1_75403.json?key=somekey&route=123532'
+              )
+    end
+
+    it 'calls valid?' do
+      expect(valid_client).to receive(:valid?)
+      valid_client.build_url
+    end
+
+    it 'returns false with valid? false' do
+      client = invalid_client
+      client.build_url
+
+      expect(client.url).to be_nil
+    end
+  end
+
+  describe '#url' do
+    it { expect(invalid_client).to respond_to(:url) }
+    it 'is set when calling build_url' do
+      client = valid_client
+      client.build_url
+
+      expect(client.url).not_to be_nil
+    end
+  end
+
+  describe '#http_response' do
+    it { expect(invalid_client).to respond_to(:http_response) }
+    it 'is set when calling #build_url' do
+      VCR.use_cassette('one_bus_away/current-time') do
+        client = valid_client
+        client.build_url
+        client.get
+
+        expect(client.http_response).not_to be_nil
+      end
+    end
+  end
+end

data/spec/one_bus_away_spec.rb

@@ -1,34 +1,131 @@
 require 'one_bus_away'
 
 RSpec.describe OneBusAway do
+  let(:one_bus_away) { OneBusAway.new }
+
   describe '.new' do
-    it 'should raise error without arguements' do
-      expect { OneBusAway.new() }.to raise_error
+    it 'responds' do
+      expect(OneBusAway).to respond_to(:new)
+    end
+
+    it 'has an accessor for parameters' do
+      one_bus_away.parameters = 'parameters'
+
+      expect(one_bus_away.parameters).to eq('parameters')
+    end
+
+    it 'has an accessor for api_method' do
+      one_bus_away.api_method = 'method'
+
+      expect(one_bus_away.api_method).to eq('method')
+    end
+
+    it 'has a reader client' do
+      expect(one_bus_away).to respond_to(:client)
+    end
+
+    it 'does not have a writer for client' do
+      expect { one_bus_away.client = '' }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe '#assign_data' do
+    let(:valid_client) { OneBusAway.new }
+
+    it 'responds' do
+      expect(one_bus_away).to respond_to(:assign_data)
+    end
+
+    it 'assigns @data', :vcr do
+      one_bus_away.current_time
+
+      expect(one_bus_away.data.entry.time).to eq(1_445_727_779_101)
+    end
+  end
+
+  describe '#data' do
+    it { is_expected.to respond_to(:data) }
+  end
+
+  describe '#call_api', :vcr do
+    it { is_expected.to respond_to(:call_api) }
+
+    it 'sets @data' do
+      one_bus_away.current_time
+
+      expect(one_bus_away.data).to be_kind_of(RecursiveOpenStruct)
     end
-    
-    it 'should accept API_KEY as arguement' do
-      expect { OneBusAway.new("somestring")}.not_to raise_error
+  end
+
+  describe '#current_time', :vcr do
+    let(:one_bus_away_client) { allow_any_instance_of(OneBusAway::Client) }
+
+    it 'responds' do
+      expect(one_bus_away).to respond_to(:current_time)
+    end
+
+    it 'creates @client' do
+      one_bus_away.current_time
+
+      expect(one_bus_away.client).to be_a(OneBusAway::Client)
+    end
+
+    it 'fails if .build_url doesnt validate' do
+      one_bus_away_client.to receive(:valid?).and_return(false)
+      allow_any_instance_of(OneBusAway)
+        .to receive(:assign_data)
+        .and_return(true)
+
+      expect { one_bus_away.current_time }
+        .to raise_error(RuntimeError, 'url is not properly built')
+    end
+
+    it 'sets http_response' do
+      one_bus_away.current_time
+
+      expect(one_bus_away.client.http_response.code).to eq(200)
     end
   end
-  
-  describe '#current_time' do
-    let(:one_bus_away) { OneBusAway.new("6a1c72f7-6ec4-4522-bf33-3698b3ad86c2") }
-    it 'returns true' do
-      expect { one_bus_away.current_time }.not_to raise_error
+
+  describe '#arrivals-and-departures-for-stop', :vcr do
+    let(:one_bus_away_client) { allow_any_instance_of(OneBusAway::Client) }
+
+    it 'responds with 1 arguments' do
+      expect(one_bus_away)
+        .to respond_to(:arrivals_and_departures_for_stop)
+        .with(1).argument
+    end
+
+    it 'creates @client' do
+      one_bus_away.arrivals_and_departures_for_stop(1_234_567)
+
+      expect(one_bus_away.client).to be_a(OneBusAway::Client)
+    end
+
+    it 'sets http_response' do
+      one_bus_away.arrivals_and_departures_for_stop(19_360)
+
+      expect(one_bus_away.client.http_response.code).to eq(200)
     end
   end
-  
-  describe '#arrivals_and_departures_for_stop' do
-    let(:one_bus_away) { OneBusAway.new("6a1c72f7-6ec4-4522-bf33-3698b3ad86c2") }
-    it 'returns true' do
-      expect { one_bus_away.arrivals_and_departures_for_stop(18145, "40", 10) }.not_to raise_error
+
+  describe '#filter_by_route', :vcr do
+    it { is_expected.to respond_to(:filter_by_route) }
+
+    it 'outputs array' do
+      one_bus_away.arrivals_and_departures_for_stop(19_360)
+
+      expect(one_bus_away.filter_by_route).to be_kind_of(Array)
     end
   end
-  
-  describe '#valid_stop?' do
-    let(:one_bus_away) { OneBusAway.new("6a1c72f7-6ec4-4522-bf33-3698b3ad86c2") }
-    it 'returns true' do
-      expect { one_bus_away.valid_stop?(18145) }.not_to raise_error
+
+  describe '#get_location', :vcr do
+    it { expect(OneBusAway.new).to respond_to(:get_location) }
+    it 'returns the latitude and longitude of a given address in Seattle' do
+      address = '400 Broad St'
+      location = one_bus_away.get_location(address)
+
+      expect(location).to eq([-122.3491348, 47.6205379])
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,91 +1,26 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'simplecov'
+require 'webmock/rspec'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+end
+SimpleCov.start
+WebMock.disable_net_connect!(allow_localhost: true)
 RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
   config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
   config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
     mocks.verify_partial_doubles = true
   end
 
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
   config.disable_monkey_patching!
 
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
+  config.warnings = false
 
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
   config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
 end