chargepoint 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3d860fa032968eb8be392dbae6dd41723dbe3be
+  data.tar.gz: f5a023b1277a7039890b411417773daa29260235
+SHA512:
+  metadata.gz: 0ef914d7858e6e3b60f71738f8629959ce8f7639ccdf4627a8e97afbabd60011310cadf40572e262164ba7547e71779d3689d9328097b2483cdeb49a72274d3d
+  data.tar.gz: b0572f49a6f4396849c23957054f15aa5e5561e751d4f007ab1f6f12cd4d9eab0709d4a807348a74953c5a33e826ff2e15b58100ff2000c47c13e7aa9b8a7067

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chargepoint.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Chargepoint
+
+A gem to wrap the ChargePoint network JSON APIs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chargepoint'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chargepoint
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/purp/chargepoint/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/chargepoint.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chargepoint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chargepoint"
+  spec.version       = ChargePoint::VERSION
+  spec.authors       = ["Jim Meyer"]
+  spec.email         = ["jim@geekdaily.org"]
+  spec.summary       = %q{A gem to wrap the ChargePoint network JSON APIs}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "https://github.com/purp/chargepoint"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "coderay", "~> 1.1" # Adds syntax highlighting in TextMate 2
+  
+  spec.add_runtime_dependency "geocoder", "~> 1.2"
+  spec.add_runtime_dependency "mechanize", "~> 2.7"
+  spec.add_runtime_dependency "nokogiri", "~> 1.6"
+end

data/lib/chargepoint.rb

@@ -0,0 +1,2 @@
+require "chargepoint/version"
+require "chargepoint/api"

data/lib/chargepoint/api.rb

@@ -0,0 +1,94 @@
+require 'mechanize'
+require 'uri'
+require 'geocoder'
+
+class ChargePoint
+  class API
+    @@authenticated = nil
+    @@agent = Mechanize.new { |agent|
+      agent.user_agent_alias = 'Mac Safari'
+    }
+
+    # TODO: automatically wrap these methods with authentication guard condition
+    AUTHENTICATED_METHODS = [:get_charge_spots]
+
+    def self.agent
+      @@agent
+    end
+
+    def self.authenticated?
+      !!@@authenticated
+    end
+
+    # TODO: automatically auth when needed and credentials available
+    # TODO: add method to see if authentication is still valid
+    def self.authenticate(params)
+      response = JSON[agent.post('https://na.chargepoint.com/users/validate', params).content]
+
+      @@authenticated = response['auth']
+    end
+
+    def self.get_charge_spots(latitude, longitude, search_radius=0.25, options={})
+      raise 'method requires authentication' unless authenticated?
+
+      params = params_with_filters(options)
+      params.merge!(search_box_for(latitude, longitude, search_radius))
+
+      uri = dashboard_uri_for_method
+      uri.query = URI.encode_www_form(params)
+
+      JSON[agent.get(uri.to_s).content]
+    end
+
+    private
+    def self.dashboard_uri_for_method
+      endpoint = caller(1)[0].scan(/\`([^']*)\'$/).flatten.first.gsub(/_([a-z])/) { $1.upcase }
+      URI.join('https://na.chargepoint.com/dashboard/', endpoint)
+    end
+
+    def self.search_box_for(latitude, longitude, search_radius)
+      search_box = {}
+
+      search_box[:lat], search_box[:lng] = latitude, longitude
+      search_box[:sw_lat], search_box[:sw_lng], search_box[:ne_lat], search_box[:ne_lng] = Geocoder::Calculations.bounding_box([latitude, longitude], search_radius)
+
+      search_box
+    end
+
+    def self.params_with_filters(options)
+      default_filters = {
+        :estimationfee => false,
+        :available => true,
+        :inuse => true,
+        :unknown => true,
+        :cp => true,
+        :other => true,
+        :l3 => true,
+        :l2 => true,
+        :l1 => false,
+        :estimate => false,
+        :fee => true,
+        :free => true,
+        :reservable => false,
+        :shared => true,
+        :chademo => true,
+        :saecombo => true,
+        :tesla => true,
+      }
+      default_options = {
+        :sort_by => 'distance',
+        :driver_connected_station_only => false,
+        :community_enabled_only => false
+      }
+
+      filters = default_filters.merge(options.delete(:filters) || {})
+
+      params = default_options.merge(options)
+      params.merge!(Hash[filters.map {|k,v| [('f_%s' % k.to_s).to_sym, v]}])
+
+      params[:_] = Time.now.to_i
+
+      params
+    end
+  end
+end

data/lib/chargepoint/version.rb

@@ -0,0 +1,3 @@
+class ChargePoint
+  VERSION = "0.0.1"
+end

data/spec/chargepoint/api_spec.rb

@@ -0,0 +1,160 @@
+def double_response(content)
+  double("Response", :content => content)
+end
+
+def allow_auth(auth_status=true)
+  response = double_response('{"auth":%s}' % auth_status)
+  allow(ChargePoint::API.agent).to receive(:post).with('https://na.chargepoint.com/users/validate', anything).and_return(response)
+end
+
+def expect_auth(auth_status=true)
+  response = double_response('{"auth":%s}' % auth_status)
+  expect(ChargePoint::API.agent).to receive(:post).with('https://na.chargepoint.com/users/validate', anything).and_return(response)
+end
+
+def expect_get
+  response = double_response('{}')
+  expect(ChargePoint::API.agent).to receive(:get).with(include('dashboard', 'getChargeSpots', 'f_reservable', 'community_enabled_only')).and_return(response)
+end
+
+def double_agent
+  @original_agent = ChargePoint::API.agent
+  ChargePoint::API.class_variable_set(:@@agent, double("Agent"))
+end
+
+def undouble_agent
+  ChargePoint::API.class_variable_set(:@@agent, @original_agent)
+end
+
+RSpec.describe ChargePoint::API do
+  subject {ChargePoint::API}
+
+  it {is_expected.to respond_to(:authenticate)}
+
+  it 'should have a list of methods requiring authentication' do
+    expect(subject::AUTHENTICATED_METHODS).to be_kind_of(Array)
+  end
+
+  it 'should have a Mechanize agent' do
+    expect(subject.agent.class).to be(Mechanize)
+  end
+
+  context '.dashboard_uri_for_method' do
+    def testing_dashboard_uri
+      ChargePoint::API.send(:dashboard_uri_for_method)
+    end
+
+    subject { @uri = testing_dashboard_uri }
+
+    it { is_expected.to be_a(URI) }
+
+    it 'should start with the dashboard URI' do
+      expect(subject.to_s).to start_with('https://na.chargepoint.com/dashboard/')
+    end
+
+    it 'should end with the calling method name camel-cased' do
+      expect(subject.to_s).to end_with('testingDashboardUri')
+    end
+  end
+
+  context '.search_box_for' do
+    it 'should have keys for center, southwest, and northeast corners' do
+      search_box = subject.send(:search_box_for, 0, 0, 1)
+      expect(search_box.keys).to contain_exactly(:lat, :lng, :sw_lat, :sw_lng, :ne_lat, :ne_lng)
+    end
+  end
+  
+  context '.params_with_filters' do
+    before :each do |example|
+      options = example.metadata[:options] || {}
+      @params = ChargePoint::API.send(:params_with_filters, options)
+    end
+
+    it 'should prefix filters with f_', :options => {:filters => {:foo => true}} do
+      expect(@params).to include(:f_foo)
+      expect(@params).not_to include(:foo)
+    end
+    
+    it 'should not prefix options', :options => {:foo => true} do
+      expect(@params).to include(:foo)
+      expect(@params).not_to include(:f_foo)
+    end
+
+    it 'should remove filters from options', :options => {:filters => {:foo => true}} do
+      expect(@params).not_to include(:filters)
+    end
+    
+    it 'should allow override of default filters and options', :options => {:sort_by => 'awesomeness', :filters => {:l1 => true}} do
+      defaults = ChargePoint::API.send(:params_with_filters, {})
+      
+      expect(defaults[:f_l1]).to eq(false)
+      expect(@params[:f_l1]).to eq(true)
+      
+      expect(defaults[:sort_by]).to eq('distance')
+      expect(@params[:sort_by]).to eq('awesomeness')
+    end
+
+    it 'should add a fresh timestamp as _' do
+      expect(@params).to include(:_)
+      expect(@params[:_]).to be_within(2).of(Time.now.to_i)
+    end
+  end
+
+  context 'when not authenticated' do
+    before :all do
+      ChargePoint::API.class_variable_set(:@@authenticated, nil)
+    end
+
+    it {is_expected.not_to be_authenticated}
+
+    it 'should not allow authenticated methods to attempt to connect' do
+      expect {subject.get_charge_spots(1,2)}.to raise_error(RuntimeError, 'method requires authentication')
+    end
+  end
+
+  context 'while authenticating' do
+    before :each do |example|
+      double_agent
+      expect_auth(example.metadata[:auth_result])
+    end
+
+    after :each do
+      undouble_agent
+    end
+
+    it 'should succeed if ChargePoint says it did', :auth_result => true do
+      expect(subject.authenticate({})).to be_truthy
+      expect(subject).to be_authenticated
+    end
+
+    it 'should fail if ChargePoint says it did', :auth_result => false do
+      expect(subject.authenticate({})).to be_falsey
+      expect(subject).not_to be_authenticated
+    end
+  end
+
+  context 'when authenticated' do
+    before :all do
+      ChargePoint::API.class_variable_set(:@@authenticated, true)
+    end
+
+    subject {ChargePoint::API}
+
+    it {is_expected.to be_authenticated}
+
+    context '.get_charge_spots' do
+      before :each do
+        double_agent
+        expect_get
+      end
+      
+      after :each do
+        undouble_agent
+      end
+      
+      it 'should construct and call the right URL' do
+        expect {subject.get_charge_spots(0,0,1)}.not_to raise_error
+      end
+    end
+  end
+end

data/spec/chargepoint_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe ChargePoint do
+  it 'should have a version number' do
+    expect {ChargePoint::VERSION}.not_to raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+$:.unshift File.expand_path('./lib')
+
+require 'chargepoint'
+
+# 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
+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
+
+    # 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

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: chargepoint
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jim Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: geocoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: 
+email:
+- jim@geekdaily.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- chargepoint.gemspec
+- lib/chargepoint.rb
+- lib/chargepoint/api.rb
+- lib/chargepoint/version.rb
+- spec/chargepoint/api_spec.rb
+- spec/chargepoint_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/purp/chargepoint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A gem to wrap the ChargePoint network JSON APIs
+test_files:
+- spec/chargepoint/api_spec.rb
+- spec/chargepoint_spec.rb
+- spec/spec_helper.rb