fizzy-api 0.0.1.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90de7d20a479ae2b27a1720d061c96e19f15b8dc
-  data.tar.gz: b068124f3d3fa7f99a0003234c5a2dc12de1a055
+  metadata.gz: 624a2b9c0580b0d25778de852143f3fee0a68f37
+  data.tar.gz: ce9858bd4eb8eab70e8ea20989e0709a146a744d
 SHA512:
-  metadata.gz: a60fb12c6b2b578d6530f749d049220edcddc67d3013627c4f6fbde487d8e1e79d34eb1f60335d1cd40b5e26a730d72f9289b85807bd664567d5e13ee4e07117
-  data.tar.gz: 2d4825db4e28e7499571b98fe6b4883c31da03baddaa34d88a3d58ec5bb9682485c44e516a8080d76245d9226b8267bbbd6efd49d72cfa032fe7ecd473e824b4
+  metadata.gz: 1fa66d4c86515d7f2d5206031497354abfc1c5a58b448c63ef7f3d2837150cf5902dbeb43116fe0c16338c08cc27f26442d66069bef3de75d1e68dc9e9fa7cc1
+  data.tar.gz: fe8271087a9a8b3b1204230141792c1dd8a1e9be9e873415051aa41614fad06e6ec1d0af27d2a26d7d475c4ffb94989bbbb97bf2a0abd3b95eaf992de3a9364c

data/.gitignore

@@ -0,0 +1,128 @@
+*.orig
+*.bak
+*.patch
+*.csv
+*~
+.ruby-version
+.rvmrc
+.ruby*
+.autotest
+.bundle
+.bundle/*
+.DS_Store
+.env
+.idea
+.loadpath
+.powrc
+.powenv
+.project
+.rspec
+.sass-cache
+.settings/*
+.tmp_*
+Guardfile.local
+.~lock.*
+app/assets/javascripts/i18n/*
+aspec
+config/database.yml
+config/mongoid.yml
+coverage
+db/hl7-backup
+db/questionnaires
+db/seeds/*.example
+doc/*/*.aux
+doc/*/.*
+doc/*/materiaal/*.psd
+log/*.log
+log/*.db
+log/*.pid
+nbproject
+public/assets
+scratch_directory
+TAGS
+tmp/**
+script/switch_to_overrides
+# Rails
+.bundle
+db/*.sqlite3
+db/*.sqlite3-journal
+*.log
+tmp
+tmp/**/*
+
+# Documentation
+doc/api
+doc/app
+.yardoc
+.yardopts
+coverage
+
+# Public Uploads
+public/system/*
+public/themes/*
+
+# Public Cache
+public/javascripts/cache
+public/stylesheets/cache
+public/refinery/*
+
+# Vendor Cache
+vendor/cache
+vendor/bundle
+vendor/extensions/**/vendor/
+vendor/extensions/**/bundle/
+
+# Acts as Indexed
+index/**/*
+
+# Refinery Specific
+*.tmproj
+*.autobackupbyrefinery.*
+refinerycms-*.gem
+
+# Mac
+.DS_Store
+
+# Windows
+Thumbs.db
+
+# NetBeans
+nbproject
+
+# Eclipse
+.project
+
+# Redcar
+.redcar
+
+# Rubinius
+*.rbc
+
+# Vim
+*.swp
+*.swo
+
+# RubyMine
+.idea
+
+# E-texteditor
+.eprj
+
+# Backup
+*~
+
+# Capybara Bug
+capybara-*html
+
+# sass
+.sass-cache
+.sass-cache/*
+
+#rvm
+.rvmrc
+.rvmrc.*
+
+# vendor/extensions dummy applications.
+vendor/extensions/**/spec/dummy
+
+*.gem

data/.rubocop.yml

@@ -0,0 +1,39 @@
+inherit_from: rubocop-todo.yml
+
+AllCops:
+  Exclude:
+    - 'fizzy_api.gemspec'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'bin/*'
+
+# Use UTF-8 as the source file encoding.
+Encoding:
+  Enabled: false
+
+# Limit lines to 80 characters.
+LineLength:
+  Max: 120
+
+# Avoid methods longer than 10 lines of code
+MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 20
+
+################################################################## DISABLED COPS
+
+# These cops are disabled because we think they are a Bad Idea. If you add one
+# here, make sure to add a comment describing what the cop does, and why this
+# is a bad idea.
+
+# Forces the argument names of the block given to #reduce to be `a, e`. Only
+# applies on single-line blocks, but why would we want to force people to use
+# less descriptive names?
+Documentation:
+  Enabled: false
+
+# Gems typically have one file named the-gem-name.rb which can be autorequired by bundler
+Style/FileName:
+  Exclude:
+    - lib/fizzy-api.rb
+

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'httparty',           '~> 0.12.0'
+gem 'active_interaction', '~> 1.3.0'
+
+group :test do
+  gem 'factory_girl_rails'
+  gem 'rspec'
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: .
+  specs:
+    fizzy-api (0.0.1.1)
+      active_interaction (~> 1.3)
+      httparty (~> 0.12)
+      virtus (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.1.8)
+      actionview (= 4.1.8)
+      activesupport (= 4.1.8)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.8)
+      activesupport (= 4.1.8)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    active_interaction (1.3.0)
+      activemodel (>= 3.2, < 5)
+    activemodel (4.1.8)
+      activesupport (= 4.1.8)
+      builder (~> 3.1)
+    activesupport (4.1.8)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    equalizer (0.0.9)
+    erubis (2.7.0)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.5.0)
+      factory_girl (~> 4.5.0)
+      railties (>= 3.0.0)
+    httparty (0.12.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.11)
+    ice_nine (0.11.1)
+    json (1.8.1)
+    minitest (5.4.3)
+    multi_xml (0.5.5)
+    parser (2.2.0.pre.8)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.1.8)
+      actionpack (= 4.1.8)
+      activesupport (= 4.1.8)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.0.0)
+    rake (10.4.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    rubocop (0.27.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.7, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.0)
+    slop (3.6.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    virtus (1.0.3)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_interaction (~> 1.3.0)
+  bundler (~> 1.7)
+  factory_girl_rails
+  fizzy-api!
+  httparty (~> 0.12.0)
+  rake (~> 10.4)
+  rspec
+  rubocop

data/README.md

@@ -0,0 +1,10 @@
+fizzy_api
+=========
+
+[![Gem Version](https://badge.fury.io/rb/fizzy-api.svg)](http://badge.fury.io/rb/fizzy-api) [![Circle CI](https://circleci.com/gh/roqua/fizzy_api.svg?style=svg)](https://circleci.com/gh/roqua/fizzy_api)
+
+Set the following ENV variables: 
+
+    ENV['FIZZY_URL']                  = 'http://fizzy.nl'
+    ENV['FIZZY_BASICAUTH_ID']         = 'basic_auth_id set in fizzy'
+    ENV['FIZZY_BASICAUTH_SECRET']     = 'secret set for fizzy clients'

data/circle.yml

@@ -0,0 +1,12 @@
+machine:
+  timezone:
+    Europe/Amsterdam
+  ruby:
+    version: 2.1.5
+test:
+  override:
+    - bundle exec rspec spec:
+        environment:
+          RAILS_ENV: test
+          RACK_ENV: test
+    - bundle exec rubocop

data/fizzy_api.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require File.expand_path('../lib/fizzy/api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'fizzy-api'
+  gem.version       = Fizzy::Api::VERSION
+  gem.summary       = "%q{API wrapper gem around Fizzy's Graph API}"
+  gem.description   = '%q{Provides authenticated access to fizzy utilities}'
+  gem.license       = 'MIT'
+  gem.authors       = ['Frank Blaauw', 'Ando Emerencia']
+  gem.email         = ['f.j.blaauw@umcg.nl', 'ando.emerencia@gmail.com']
+  gem.homepage      = 'http://github.com/roqua/fizzy_api'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'httparty',                       '~> 0.12'
+  gem.add_dependency 'active_interaction',             '~> 1.3'
+  gem.add_dependency 'virtus',                         '~> 1.0'
+
+  gem.add_development_dependency 'bundler',            '~> 1.7'
+  gem.add_development_dependency 'rake',               '~> 10.4'
+  gem.add_development_dependency 'rspec',              '~> 3.1'
+  gem.add_development_dependency 'factory_girl_rails', '~> 4.5'
+end

data/lib/fizzy/api/calculate_outcome.rb

@@ -0,0 +1,28 @@
+module Fizzy
+  module Api
+    class CalculateOutcome < ActiveInteraction::Base
+      string :dossier_id
+      string :protocol_subscription_id
+
+      def execute
+        response = Api.basic_auth_session.post("/dossier/#{dossier_id}"\
+                                               "/protocol_subscriptions/#{protocol_subscription_id}"\
+                                               '/calculate')
+        process_response(response)
+      end
+
+      private
+
+      def process_response(response)
+        case response.code
+        when 200
+          response
+        when 404
+          fail Errors::GraphNotFoundError, 'Participant not found, or graph not supported.'
+        else
+          fail Errors::UnexpectedStatusError, "Status code #{response.code} not expected."
+        end
+      end
+    end
+  end
+end

data/lib/fizzy/api/errors/graph_not_found_error.rb

@@ -0,0 +1,8 @@
+module Fizzy
+  module Api
+    module Errors
+      class GraphNotFoundError < StandardError
+      end
+    end
+  end
+end

data/lib/fizzy/api/errors/outcome_not_available_error.rb

@@ -0,0 +1,8 @@
+module Fizzy
+  module Api
+    module Errors
+      class OutcomeNotAvailableError < StandardError
+      end
+    end
+  end
+end

data/lib/fizzy/api/errors/too_few_measurements_error.rb

@@ -0,0 +1,8 @@
+module Fizzy
+  module Api
+    module Errors
+      class TooFewMeasurementsError < StandardError
+      end
+    end
+  end
+end

data/lib/fizzy/api/errors/unexpected_status_error.rb

@@ -0,0 +1,8 @@
+module Fizzy
+  module Api
+    module Errors
+      class UnexpectedStatusError < StandardError
+      end
+    end
+  end
+end

data/lib/fizzy/api/errors.rb

@@ -0,0 +1,4 @@
+require 'fizzy/api/errors/graph_not_found_error'
+require 'fizzy/api/errors/outcome_not_available_error'
+require 'fizzy/api/errors/too_few_measurements_error'
+require 'fizzy/api/errors/unexpected_status_error'

data/lib/fizzy/api/render_graph.rb

@@ -0,0 +1,34 @@
+module Fizzy
+  module Api
+    class RenderGraph < ActiveInteraction::Base
+      string :dossier_id
+      string :protocol_subscription_id
+      string :path
+      hash :options, default: {}
+
+      def execute
+        response = Api.basic_auth_session.get("/dossier/#{dossier_id}"\
+                                   "/protocol_subscriptions/#{protocol_subscription_id}" \
+                                   "/render/#{path}", options)
+        process_response(response)
+      end
+
+      private
+
+      def process_response(response)
+        case response.code
+        when 200
+          response
+        when 202
+          fail Errors::OutcomeNotAvailableError, 'The results have not yet been calculated.'
+        when 204
+          fail Errors::TooFewMeasurementsError, 'Not enough measurements available.'
+        when 404
+          fail Errors::GraphNotFoundError, 'Graph not found.'
+        else
+          fail Errors::UnexpectedStatusError, "Status code #{response.code} not expected."
+        end
+      end
+    end
+  end
+end

data/lib/fizzy/api/sessions/basic_auth_session.rb

@@ -0,0 +1,87 @@
+module Fizzy
+  module Api
+    module Sessions
+      class BasicAuthSession
+        attr_reader :fizzy_url
+        attr_reader :username
+        attr_reader :password
+
+        def initialize(fizzy_url: ENV['FIZZY_URL'],
+                       username: ENV['FIZZY_BASICAUTH_ID'],
+                       password: ENV['FIZZY_BASICAUTH_SECRET'])
+          @fizzy_url = fizzy_url
+          @username = username
+          @password = password
+        end
+
+        def get(path, params = {})
+          perform_request_or_fail do
+            HTTParty.get(full_url_for(path),
+                         query: params,
+                         basic_auth: basic_auth)
+          end
+        end
+
+        def post(path, params = {})
+          perform_request_or_fail do
+            HTTParty.post(full_url_for(path),
+                          headers: { 'Content-Type' => 'application/json' },
+                          body: params.to_json,
+                          basic_auth: basic_auth)
+          end
+        end
+
+        def patch(path, params = {})
+          perform_request_or_fail do
+            HTTParty.patch(full_url_for(path),
+                           headers: { 'Content-Type' => 'application/json' },
+                           body: params.to_json,
+                           basic_auth: basic_auth)
+          end
+        end
+
+        def delete(path, params = {})
+          perform_request_or_fail do
+            HTTParty.delete(full_url_for(path),
+                            query: params,
+                            basic_auth: basic_auth)
+          end
+        end
+
+        private
+
+        def perform_request_or_fail(&_block)
+          response = yield
+          case response.code
+          when 401
+            access_denied(response)
+          when 500
+            fail response.parsed_response || "Received HTTP response code #{response.code}!"
+          else
+            response
+          end
+        end
+
+        def access_denied(response)
+          if response.headers['WWW-Authenticate']
+            fail NoSession
+          else
+            fail Unauthorized
+          end
+        end
+
+        def full_url_for(path)
+          fizzy_url + api_base + path
+        end
+
+        def api_base
+          '/api/v1'
+        end
+
+        def basic_auth
+          { username: username, password: password }
+        end
+      end
+    end
+  end
+end

data/lib/fizzy/api/sessions.rb

@@ -0,0 +1,10 @@
+require 'httparty'
+require 'fizzy/api/sessions/basic_auth_session'
+
+module Fizzy
+  module Api
+    def self.basic_auth_session(*arguments, &block)
+      Sessions::BasicAuthSession.new(*arguments, &block)
+    end
+  end
+end

data/lib/fizzy/api/version.rb

@@ -0,0 +1,5 @@
+module Fizzy
+  module Api
+    VERSION = '0.0.2'
+  end
+end

data/lib/fizzy/api.rb

@@ -0,0 +1,16 @@
+require 'active_interaction'
+require 'fizzy/api/version'
+require 'fizzy/api/sessions'
+require 'fizzy/api/models'
+require 'fizzy/api/errors'
+
+require 'fizzy/api/calculate_outcome'
+require 'fizzy/api/render_graph'
+
+module Fizzy
+  module Api
+    # Raised when a request failed due to an expired/non-existing session.
+    class NoSession < StandardError; end
+    class Unauthorized < StandardError; end
+  end
+end

data/lib/fizzy-api.rb

@@ -0,0 +1 @@
+require 'fizzy/api'

data/spec/factories/basic_auth_session.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :basic_auth_session do
+    initialize_with { new(username: 'some_username', password: 'some_password', fizzy_url: 'http://fizzy.dev') }
+  end
+end

data/spec/fizzy/api/calculate_outcome_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+module Fizzy
+  module Api
+    describe CalculateOutcome do
+      let(:dossier_id) { '123' }
+      let(:protocol_subscription_id) { 'abc' }
+      let(:response) { httparty_response('') }
+      let(:session)  { FactoryGirl.build :basic_auth_session }
+
+      before do
+        allow(Sessions::BasicAuthSession).to receive(:new).and_return session
+        allow(session).to receive(:post).and_return nil
+      end
+
+      it 'should call the correct url' do
+        expect(session).to receive(:post)
+          .with("/dossier/#{dossier_id}/protocol_subscriptions/#{protocol_subscription_id}/calculate")
+          .and_return(response)
+
+        described_class.run! dossier_id: dossier_id,
+                             protocol_subscription_id: protocol_subscription_id
+      end
+
+      describe 'error handling' do
+        it 'should notice a 404' do
+          allow(response).to receive(:code).and_return 404
+          expect(session).to receive(:post)
+            .with('/dossier/fake/protocol_subscriptions/fake/calculate')
+            .and_return(response)
+          outcome = lambda do
+            described_class.run! dossier_id: 'fake',
+                                 protocol_subscription_id: 'fake'
+          end
+          expect { outcome.call }.to raise_error(Errors::GraphNotFoundError)
+        end
+
+        it 'should fail a 500 with an UnexpectedStatusError' do
+          allow(response).to receive(:code).and_return 500
+          expect(session).to receive(:post)
+            .with('/dossier/fake/protocol_subscriptions/fake/calculate')
+            .and_return(response)
+          outcome = lambda do
+            described_class.run! dossier_id: 'fake',
+                                 protocol_subscription_id: 'fake'
+          end
+          expect { outcome.call }.to raise_error(Errors::UnexpectedStatusError)
+        end
+      end
+    end
+  end
+end

data/spec/fizzy/api/render_graph_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+module Fizzy
+  module Api
+    describe RenderGraph do
+      let(:dossier_id) { '123' }
+      let(:protocol_subscription_id) { 'abc' }
+      let(:path) { 'welbevinden.svg' }
+      let(:options) { {} }
+      let(:response) { httparty_response('<svg>') }
+      let(:session)  { FactoryGirl.build :basic_auth_session }
+
+      before do
+        allow(Sessions::BasicAuthSession).to receive(:new).and_return session
+      end
+
+      it 'should call the correct url' do
+        expect(session).to receive(:get)
+          .with("/dossier/#{dossier_id}/protocol_subscriptions/#{protocol_subscription_id}/render/#{path}", options)
+          .and_return(response)
+        outcome = described_class.run! dossier_id: dossier_id,
+                                       protocol_subscription_id: protocol_subscription_id,
+                                       path: path,
+                                       options: options
+        expect(outcome).to eq '<svg>'
+      end
+
+      describe 'error handling' do
+        it 'should notice a 202' do
+          allow(response).to receive(:code).and_return 202
+          expect(session).to receive(:get)
+            .with("/dossier/#{dossier_id}/protocol_subscriptions/#{protocol_subscription_id}/render/#{path}", options)
+            .and_return(response)
+          outcome = lambda do
+            described_class.run! dossier_id: dossier_id,
+                                 protocol_subscription_id: protocol_subscription_id,
+                                 path: path,
+                                 options: options
+          end
+          expect { outcome.call }.to raise_error(Errors::OutcomeNotAvailableError)
+        end
+
+        it 'should notice a 204' do
+          allow(response).to receive(:code).and_return 204
+          expect(session).to receive(:get)
+            .with("/dossier/#{dossier_id}/protocol_subscriptions/#{protocol_subscription_id}/render/#{path}", options)
+            .and_return(response)
+          outcome = lambda do
+            described_class.run! dossier_id: dossier_id,
+                                 protocol_subscription_id: protocol_subscription_id,
+                                 path: path,
+                                 options: options
+          end
+          expect { outcome.call }.to raise_error(Errors::TooFewMeasurementsError)
+        end
+
+        it 'should notice a 404' do
+          allow(response).to receive(:code).and_return 404
+          expect(session).to receive(:get)
+            .with("/dossier/#{dossier_id}/protocol_subscriptions/#{protocol_subscription_id}/render/#{path}", options)
+            .and_return(response)
+          outcome = lambda do
+            described_class.run! dossier_id: dossier_id,
+                                 protocol_subscription_id: protocol_subscription_id,
+                                 path: path,
+                                 options: options
+          end
+          expect { outcome.call }.to raise_error(Errors::GraphNotFoundError)
+        end
+
+        it 'should fail a 500 with an UnexpectedStatusError' do
+          allow(response).to receive(:code).and_return 500
+          expect(session).to receive(:get)
+            .with("/dossier/#{dossier_id}/protocol_subscriptions/#{protocol_subscription_id}/render/#{path}", options)
+            .and_return(response)
+          outcome = lambda do
+            described_class.run! dossier_id: dossier_id,
+                                 protocol_subscription_id: protocol_subscription_id,
+                                 path: path,
+                                 options: options
+          end
+          expect { outcome.call }.to raise_error(Errors::UnexpectedStatusError)
+        end
+      end
+    end
+  end
+end

data/spec/fizzy/api/sessions/basic_auth_session_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+include Sessions
+
+describe BasicAuthSession do
+  let(:session)  { FactoryGirl.build :basic_auth_session }
+  let(:response) { double('response', code: 201, parsed_response: 'some_response') }
+
+  describe '#initialize' do
+    it 'sets the fizzy_url instance attribute' do
+      session = Fizzy::Api.basic_auth_session fizzy_url: 'some_fizzy_url'
+      expect(session.fizzy_url).to eq('some_fizzy_url')
+    end
+
+    it 'defaults the fizzy_url to the FIZZY_URL env variable' do
+      orginal_env_fizzy_url = ENV['FIZZY_URL']
+      ENV['FIZZY_URL'] = 'some_env_fizzy_url'
+      session = Fizzy::Api.basic_auth_session
+      ENV['FIZZY_URL'] = orginal_env_fizzy_url
+      expect(session.fizzy_url).to eq('some_env_fizzy_url')
+    end
+
+    it 'sets the username instance variable' do
+      session = Fizzy::Api.basic_auth_session username: 'some_username'
+      expect(session.username).to eq('some_username')
+    end
+
+    it 'defaults the username to the FIZZY_BASICAUTH_ID env variable' do
+      orginal_env_fizzy_key = ENV['FIZZY_BASICAUTH_ID']
+      ENV['FIZZY_BASICAUTH_ID'] = 'some_env_fizzy_key'
+      session = Fizzy::Api.basic_auth_session
+      ENV['FIZZY_BASICAUTH_ID'] = orginal_env_fizzy_key
+      expect(session.username).to eq('some_env_fizzy_key')
+    end
+
+    it 'sets the password instance variable' do
+      session = Fizzy::Api.basic_auth_session password: 'some_password'
+      expect(session.password).to eq('some_password')
+    end
+
+    it 'defaults the password to the FIZZY_BASICAUTH_SECRET env variable' do
+      orginal_env_fizzy_secret = ENV['FIZZY_BASICAUTH_SECRET']
+      ENV['FIZZY_BASICAUTH_SECRET'] = 'some_env_fizzy_secret'
+      session = Fizzy::Api.basic_auth_session
+      ENV['FIZZY_BASICAUTH_SECRET'] = orginal_env_fizzy_secret
+      expect(session.password).to eq('some_env_fizzy_secret')
+    end
+  end
+
+  describe '#get' do
+    it 'performs a get request' do
+      expect(HTTParty).to receive(:get).with('http://fizzy.dev/api/v1/some_path',
+                                             query: { some: 'param' },
+                                             basic_auth: { username: 'some_username', password: 'some_password' })
+        .and_return(response)
+      session.get '/some_path', some: 'param'
+    end
+
+    it 'throws an error if the reponse is not within the 200 range' do
+      allow(response).to receive(:code).and_return(500)
+      allow(HTTParty).to receive(:get).and_return(response)
+      expect { session.get '/some_path' }.to raise_error(RuntimeError, 'some_response')
+    end
+
+    it 'throws a NoSession error if the basic auth is incorrect' do
+      allow(response).to receive(:code).and_return(401)
+      allow(HTTParty).to receive(:get).and_return(response)
+      allow(response).to receive(:headers).and_return('WWW-Authenticate' => 'Basic realm="Application"')
+      expect { session.get '/some_path' }.to raise_error(Fizzy::Api::NoSession)
+    end
+
+    it 'throws a Unauthorized error on 401 without www-authenticate header' do
+      allow(response).to receive(:code).and_return(401)
+      allow(HTTParty).to receive(:get).and_return(response)
+      allow(response).to receive(:headers).and_return('foo' => 'bar')
+      expect { session.get '/some_path' }.to raise_error(Fizzy::Api::Unauthorized)
+    end
+
+    it 'returns the response' do
+      allow(HTTParty).to receive(:get).and_return(response)
+      expect(session.get '/some_path').to eq(response)
+    end
+  end
+end

data/spec/fizzy/api/sessions_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+require 'factory_girl_rails'
+require 'fizzy-api'
+require 'httparty'
+include Fizzy::Api
+include Fizzy::Api::Sessions
+# include Fizzy::Api::Models
+
+Dir[File.join(File.expand_path(File.dirname(__FILE__)), 'support', '*.rb')].each { |f| require f }
+Dir[File.join(File.expand_path(File.dirname(__FILE__)), 'factories', '*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+end
+
+# I18n.load_path << Dir[File.join(File.expand_path(File.dirname(__FILE__)), 'support', '*.yml')]

data/spec/support/httparty_helpers.rb

@@ -0,0 +1,5 @@
+def httparty_response(response_data)
+  allow(response_data).to receive(:code).and_return 200
+  allow(response_data).to receive(:parsed_response).and_return response_data
+  response_data
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fizzy-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Frank Blaauw
@@ -109,15 +109,44 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.5'
-description: Provides authenticated access to ROM utilities
+description: "%q{Provides authenticated access to fizzy utilities}"
 email:
 - f.j.blaauw@umcg.nl
-- acemerencia@gmail.com
+- ando.emerencia@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: http://fizzy.com
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- circle.yml
+- fizzy_api.gemspec
+- lib/fizzy-api.rb
+- lib/fizzy/api.rb
+- lib/fizzy/api/calculate_outcome.rb
+- lib/fizzy/api/errors.rb
+- lib/fizzy/api/errors/graph_not_found_error.rb
+- lib/fizzy/api/errors/outcome_not_available_error.rb
+- lib/fizzy/api/errors/too_few_measurements_error.rb
+- lib/fizzy/api/errors/unexpected_status_error.rb
+- lib/fizzy/api/models.rb
+- lib/fizzy/api/render_graph.rb
+- lib/fizzy/api/sessions.rb
+- lib/fizzy/api/sessions/basic_auth_session.rb
+- lib/fizzy/api/version.rb
+- rubocop-todo.yml
+- spec/factories/basic_auth_session.rb
+- spec/fizzy/api/calculate_outcome_spec.rb
+- spec/fizzy/api/render_graph_spec.rb
+- spec/fizzy/api/sessions/basic_auth_session_spec.rb
+- spec/fizzy/api/sessions_spec.rb
+- spec/spec_helper.rb
+- spec/support/httparty_helpers.rb
+homepage: http://github.com/roqua/fizzy_api
 licenses:
 - MIT
 metadata: {}
@@ -140,5 +169,12 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: API wrapper gem around Fizzy's Graph API
-test_files: []
+summary: "%q{API wrapper gem around Fizzy's Graph API}"
+test_files:
+- spec/factories/basic_auth_session.rb
+- spec/fizzy/api/calculate_outcome_spec.rb
+- spec/fizzy/api/render_graph_spec.rb
+- spec/fizzy/api/sessions/basic_auth_session_spec.rb
+- spec/fizzy/api/sessions_spec.rb
+- spec/spec_helper.rb
+- spec/support/httparty_helpers.rb