clear-election-sdk 0.0.1

data/spec/ballot_spec.rb

@@ -0,0 +1,94 @@
+describe ClearElection::Ballot do
+
+  let(:election) { ClearElection::Factory.election} 
+
+  describe "complete valid ballot" do
+
+    let(:ballot) { ClearElection::Factory.ballot(election) }
+
+    it "is valid" do
+      ballot.validate(election)
+      expect(ballot).to be_valid
+    end
+  end
+
+  describe "incomplete ballot" do
+
+    let(:ballot) { ClearElection::Factory.ballot(election, complete: false) }
+
+    it "is not fully valid" do
+      ballot.validate(election)
+      expect(ballot).not_to be_valid
+      expect(ballot.errors.first[:message]).to include 'missing contest'
+    end
+
+    it "is valid subject to incompleteness" do
+      ballot.validate(election, complete:false)
+      expect(ballot).to be_valid
+    end
+
+  end
+
+  describe "invalid ballot" do
+
+    def test_invalid_ballot(election, invalid, message)
+      ballot = ClearElection::Factory.ballot(election, invalid: invalid)
+      ballot.validate(election)
+      expect(ballot).not_to be_valid
+      expect(ballot.errors.first[:message]).to include message
+    end
+
+    it "validates contestId" do
+      test_invalid_ballot election, :contestId, "Invalid contest id"
+    end
+
+    it "validates candidateId" do
+      test_invalid_ballot election, :candidateId, "Invalid candidate id"
+    end
+
+    it "validates writeins allowed" do
+      election = ClearElection::Factory.election(writeIn: false)
+      test_invalid_ballot election, :writeIn, "Write-in not allowed"
+    end
+
+    it "validates unique choices" do
+      test_invalid_ballot election, :duplicateChoice, "Duplicate choices"
+    end
+
+    it "validates ranking" do
+      test_invalid_ballot election, :ranking, "Invalid ranking"
+    end
+
+    it "validates multiplicity (too few)" do
+      test_invalid_ballot election, :multiplicityTooFew, "Invalid multiplicity"
+    end
+
+    it "validates multiplicity (too many)" do
+      test_invalid_ballot election, :multiplicityTooMany, "Invalid multiplicity"
+    end
+  end
+
+  describe "json" do
+
+    let(:ballot) { ClearElection::Factory.ballot(election) }
+
+    it "makes round trip" do
+      original_json = JSON.generate ballot.as_json
+      final_json = JSON.generate ClearElection::Ballot.from_json(JSON.parse original_json).as_json
+      expect(final_json).to eq original_json
+    end
+  end
+
+  describe "order" do
+    it "is by ballotId" do
+      ballots = 4.times.map { ClearElection::Factory.ballot(election) }
+      expect(ballots.shuffle.sort.each_cons(2)).to be_all { |a, b| a.ballotId < b.ballotId }
+    end
+
+    it "of contests is by contestId" do
+      ballot =  ClearElection::Factory.ballot(election)
+      expect(ballot.contests.shuffle.sort.each_cons(2)).to be_all { |a, b| a.contestId < b.contestId }
+    end
+  end
+
+end

data/spec/clear_election_spec.rb

@@ -0,0 +1,11 @@
+describe ClearElection do
+
+  it "reads an election" do
+    uri = ClearElection::Factory.election_uri
+    election = ClearElection::Factory.election
+
+    stub_request(:get, uri).to_return(body: JSON.generate(election.as_json))
+    expect(ClearElection.read(uri).as_json).to eq election.as_json
+  end
+
+end

data/spec/election_spec.rb

@@ -0,0 +1,49 @@
+describe ClearElection::Election do
+
+  let(:election) { ClearElection::Factory.election }
+  let(:pre_open_time) { election.pollsOpen - 1 }
+  let(:while_open_time) { election.pollsOpen + (election.pollsClose - election.pollsOpen)/2 }
+  let(:post_close_time) { election.pollsClose + 1 }
+
+  describe "polls_are_now_open?" do
+
+    it "returns false before polls open" do
+      Timecop.travel pre_open_time do
+        expect(election.polls_are_now_open?).to be_falsey
+      end
+    end
+
+    it "returns true while polls are open" do
+      Timecop.travel while_open_time do
+        expect(election.polls_are_now_open?).to be_truthy
+      end
+    end
+
+    it "returns false after polls close" do
+      Timecop.travel post_close_time do
+        expect(election.polls_are_now_open?).to be_falsey
+      end
+    end
+  end
+
+  describe "polls_are_now_closed?" do
+
+    it "returns false before polls open" do
+      Timecop.travel pre_open_time do
+        expect(election.polls_are_now_closed?).to be_falsey
+      end
+    end
+
+    it "returns false while polls are open" do
+      Timecop.travel while_open_time do
+        expect(election.polls_are_now_closed?).to be_falsey
+      end
+    end
+
+    it "returns false after polls close" do
+      Timecop.travel post_close_time do
+        expect(election.polls_are_now_closed?).to be_truthy
+      end
+    end
+  end
+end

data/spec/rspec_spec.rb

@@ -0,0 +1,152 @@
+ClearElection::Rspec.setup agent: true
+
+#
+# Stub out some rails-specific definitions.  These come into play when
+# `:agent` is passed as true to ClearElection::Rspec.setup; which then sets
+# things up so that rspec-rails will use a particular agent URI as the
+# app root.
+#
+module ::Rails
+  def self.root 
+    Pathname.new("spec")
+  end
+end
+
+$rspec_rails_request_host = "example.com"
+
+def host!(hostname)
+  $rspec_rails_request_host = hostname
+end
+
+module ::ActionDispatch
+  class Request
+    def initialize(path)
+      @path = path
+    end
+    def base_url
+      "http://#{$rspec_rails_request_host}"
+    end
+    def original_fullpath
+      @path
+    end
+    def original_url
+      "Expect me to be overriden"
+    end
+  end
+end
+
+
+describe ClearElection::Rspec do
+
+  describe "stub_election_uri" do
+    it "stubs a valid election uri" do
+      election = ClearElection::Factory.election
+      uri = stub_election_uri(election: election)
+      expect(ClearElection.read(uri).as_json).to eq election.as_json
+    end
+
+    it "stubs an invalid election uri" do
+      uri = stub_election_uri(valid: false)
+      expect(ClearElection.read(uri)).to be_nil
+    end
+  end
+
+  describe "stub_election_access_token" do
+    let(:election)     { ClearElection::Factory.election }
+    let(:election_uri) { stub_election_uri(election: election) }
+    let(:accessToken) { SecureRandom.hex(10) }
+    let(:demographic) { { "group" => "A" } }
+
+    it "stubs a uri that accepts access token and returns demographic" do
+      stub_election_access_token(election_uri: election_uri, accessToken: accessToken, demographic: demographic)
+      response = Faraday.post(election.signin.uri + "redeem", { election: election_uri, accessToken: accessToken })
+      response_json = JSON.parse response.body
+      expect(response_json).to eq "demographic" => demographic
+    end
+
+    it "stubs a uri that rejects access token" do
+      stub_election_access_token(election_uri: election_uri, accessToken: accessToken, demographic: demographic, valid: false)
+      response = Faraday.post(election.signin.uri + "redeem", { election: election_uri, accessToken: accessToken })
+      expect(response.status).to eq 403
+    end
+  end
+
+  describe "rails requests" do
+    it "hacks request.original_url to be based at my agent url" do
+      path = "/relative/path"
+      request = ActionDispatch::Request.new(path)
+      expect(request.original_url).to eq my_agent_uri + path
+    end
+  end
+
+
+  describe "api election validation" do
+    Response = Struct.new(:status, :body) do
+      def has_http_status?(status)
+        self.status == status
+      end
+    end
+
+    def response
+      @response
+    end
+
+    def set_response(status: 200, error: nil)
+      body = {}
+      body["error"] = error if error
+      @response = Response.new(status, JSON.generate(body))
+    end
+
+    describe "verifies election agent" do
+      it_behaves_like "api that validates election URI", agent: :booth do
+        let(:apicall) { -> uri {
+          election = ClearElection.read(uri)
+          case
+          when election.nil? then                 set_response status: 422, error: "invalid uri"
+          when election.booth.uri != my_agent_uri then set_response status: 422, error: "not booth agent"
+          else                                    set_response
+          end
+        } }
+      end
+    end
+
+    describe "verifies election is open" do
+      it_behaves_like "api that validates election URI", state: :open do
+        let(:apicall) { -> uri {
+          election = ClearElection.read(uri)
+          case
+          when election.nil? then                 set_response status: 422, error: "invalid uri"
+          when !election.polls_are_now_open? then set_response status: 403, error: "polls not open"
+          else                                    set_response
+          end
+        } }
+      end
+    end
+
+    describe "verifies election is closed" do
+      it_behaves_like "api that validates election URI", state: :closed do
+        let(:apicall) { -> uri {
+          election = ClearElection.read(uri)
+          case
+          when election.nil? then                   set_response status: 422, error: "invalid uri"
+          when !election.polls_are_now_closed? then set_response status: 403, error: "polls not closed"
+          else                                      set_response
+          end
+        } }
+      end
+    end
+
+    describe "verifies election hasn't opened" do
+      it_behaves_like "api that validates election URI", state: :unopen do
+        let(:apicall) { -> uri {
+          election = ClearElection.read(uri)
+          case
+          when election.nil? then                    set_response status: 422, error: "invalid uri"
+          when !election.polls_have_not_opened? then set_response status: 403, error: "polls have opened"
+          else                                       set_response
+          end
+        } }
+      end
+    end
+  end
+end

data/spec/schema_spec.rb

@@ -0,0 +1,9 @@
+describe ClearElection::Schema do
+
+  describe "api" do
+    it "returns booth agent schema with ballot schema expanded in it" do
+      schema = ClearElection::Schema.api("booth-agent", version: "0.0")
+      expect(schema["definitions"]["ballot"]["title"]).to eq "Ballot"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'coveralls'
+require 'simplecov'
+require 'simplecov-gem-profile'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start "gem"
+
+require 'timecop'
+
+require 'clear-election-sdk'
+require 'clear-election-sdk/rspec'
+
+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
+
+  config.warnings = true
+
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: clear-election-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ronen barzel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-gem-profile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby SDK for working with ClearElection data.  Also includes factory
+  and rspec helpers for testing apps
+email:
+- ronen@barzel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- clear-election-sdk.gemspec
+- lib/clear-election-sdk.rb
+- lib/clear-election-sdk/ballot.rb
+- lib/clear-election-sdk/election.rb
+- lib/clear-election-sdk/factory.rb
+- lib/clear-election-sdk/rspec.rb
+- lib/clear-election-sdk/schema.rb
+- lib/clear-election-sdk/version.rb
+- schemas/api/booth-agent-0.0.schema.json
+- schemas/ballot-0.0.schema.json
+- schemas/election-0.0.schema.json
+- spec/ballot_spec.rb
+- spec/clear_election_spec.rb
+- spec/election_spec.rb
+- spec/rspec_spec.rb
+- spec/schema_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ClearElection/clear-election-sdk-ruby
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for working with ClearElection data
+test_files:
+- spec/ballot_spec.rb
+- spec/clear_election_spec.rb
+- spec/election_spec.rb
+- spec/rspec_spec.rb
+- spec/schema_spec.rb
+- spec/spec_helper.rb