psc 0.0.1

data/lib/psc/faraday/string_is_xml.rb

@@ -0,0 +1,25 @@
+require 'psc/faraday'
+
+module Psc
+  module Faraday
+    ##
+    # Middleware which sets the request content type to `text/xml` if
+    # the provided body is a `String` and the content type isn't
+    # already set.
+    class StringIsXml
+      def initialize(app)
+        @app = app
+      end
+
+      ##
+      # Sets the content type request header if appropriate
+      def call(env)
+        if String === env[:body]
+          env[:request_headers]['Content-Type'] ||= 'text/xml'
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/psc/version.rb

@@ -0,0 +1,3 @@
+module Psc
+  VERSION = '0.0.1'
+end

data/meta.rakefile

@@ -0,0 +1,30 @@
+PLATFORMS = {
+  :ruby18 => 'ruby-1.8.7-p334',
+  :jruby  => 'jruby-1.6.1',
+  :ruby19 => 'ruby-1.9.2-p180'
+}
+
+BUNDLER_VERSION = '1.0.13'
+
+def ci_env
+  (ENV["PSC_RB_ENV"] || :ruby18).to_sym
+end
+
+namespace :ci do
+  task :rvmrc do
+    puts "#{PLATFORMS[ci_env]}@psc-rb"
+  end
+
+  task :ensure_bundler_available do
+    unless Gem.available?('bundler', BUNDLER_VERSION)
+      puts "Installing bundler"
+      sh "gem install bundler -v '#{BUNDLER_VERSION}'"
+    end
+  end
+
+  task :setup => [:ensure_bundler_available] do
+    sh "bundle _#{BUNDLER_VERSION}_ update"
+  end
+end
+
+task :default => 'ci:setup'

data/psc.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "psc/version"
+
+Gem::Specification.new do |s|
+  s.name        = "psc"
+  s.version     = Psc::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rhett Sutphin"]
+  s.email       = ["r-sutphin@northwestern.edu"]
+  s.homepage    = "https://github.com/NUBIC/psc.rb"
+  s.summary     = "A lightweight ruby client for Patient Study Calendar's RESTful HTTP API"
+  s.description = "A lightweight ruby client for Patient Study Calendar's RESTful HTTP API"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'faraday', '~> 0.7.0'
+  s.add_dependency 'builder', '>= 2.1.2'
+  s.add_dependency 'faraday-stack', '~> 0.1.1'
+  s.add_dependency 'nokogiri', '~> 1.4'
+  s.add_dependency 'activesupport', '>= 2.3' # for the JSON adapter
+
+  s.add_development_dependency 'rspec', '~> 2.6'
+  s.add_development_dependency 'ci_reporter', '~> 1.6'
+  s.add_development_dependency 'cucumber', '~> 0.10.2'
+  s.add_development_dependency 'childprocess', '~> 0.1'
+  s.add_development_dependency 'highline'
+  s.add_development_dependency 'webmock', '~> 1.6'
+  s.add_development_dependency 'yard', '~> 0.6.8'
+end

data/spec/fixtures/studies-json.http

@@ -0,0 +1,37 @@
+HTTP/1.1 200 OK
+Date: Mon, 16 May 2011 21:47:14 GMT
+Server: Restlet-Framework/2.0.3
+Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+Pragma: no-cache
+Accept-Ranges: bytes
+Vary: Accept-Charset,Accept-Encoding,Accept-Language,Accept
+Content-Type: application/json
+Connection: close
+Transfer-Encoding: chunked
+
+{
+  "studies": [
+    {
+      "privileges": [
+        "develop",
+        "see-development",
+        "set-managing-sites",
+        "release",
+        "assign-identifiers",
+        "purge"
+      ],
+      "assigned_identifier": "NU 1404"
+    },
+    {
+      "privileges": [
+        "develop",
+        "see-development",
+        "set-managing-sites",
+        "release",
+        "assign-identifiers",
+        "purge"
+      ],
+      "assigned_identifier": "ECOG 5607"
+    }
+  ]
+}

data/spec/middleware_helper.rb

@@ -0,0 +1,18 @@
+shared_context 'middleware' do
+  let(:app) { mock('app') }
+  let(:env) { { :request_headers => ::Faraday::Utils::Headers.new } }
+  let(:headers) { env[:request_headers] }
+
+  before { app.stub!(:call) }
+
+  def do_call
+    subject.call(env)
+  end
+end
+
+shared_examples 'unconditional middleware' do
+  it 'continues the chain' do
+    app.should_receive(:call)
+    subject.call(env)
+  end
+end

data/spec/psc/client_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path("../../spec_helper.rb", __FILE__)
+
+module Psc
+  describe Client do
+    let(:options) { { :authenticator => { :basic => %w(superuser superuser) } } }
+    let(:url) { 'http://psc.example.org/' }
+    let(:client) { Psc::Client.new(url, options) }
+
+    def mockable_uri(path)
+      URI.join(url.sub(%r{//}, '//superuser:superuser@'), "api/v1/#{path}").to_s
+    end
+
+    describe '.new' do
+      it 'creates a connection from a string and options' do
+        client.connection.should be_a(Psc::Connection)
+      end
+
+      it 'yields a connection builder if given a block' do
+        client = Psc::Client.new(url, options) do |builder|
+          builder.response :logger
+        end
+        client.connection.builder[-2].should == ::Faraday::Response::Logger
+      end
+    end
+
+    describe '#studies' do
+      before do
+        stub_request(:get, mockable_uri('studies.json')).
+          to_return(http_fixture('studies-json'))
+      end
+
+      let(:actual) { client.studies }
+
+      it "has the data from the response" do
+        actual.first['assigned_identifier'].should == 'NU 1404'
+      end
+    end
+  end
+end

data/spec/psc/connection_spec.rb

@@ -0,0 +1,156 @@
+require File.expand_path("../../spec_helper.rb", __FILE__)
+
+module Psc
+  describe Connection do
+    let(:conn) {
+      Psc::Connection.new('http://psc.example.org/', options)
+    }
+
+    let(:options) {
+      { :authenticator => { :basic => ['foo', 'bar'] } }
+    }
+
+    describe 'appending the API path' do
+      def actual_path_prefix(url)
+        Psc::Connection.new(url, options).path_prefix
+      end
+
+      it 'is appended correctly if the URL ends with a slash' do
+        actual_path_prefix('http://psc.example.org/').should == '/api/v1'
+      end
+
+      it 'is appended correctly if the URL does not end with a slash' do
+        actual_path_prefix('http://psc.example.org').should == '/api/v1'
+      end
+
+      it 'is appended correctly if the URL has path info that ends with a slash' do
+        actual_path_prefix('http://www.example.net/psc/').should == '/psc/api/v1'
+      end
+
+      it 'is appended correctly if the URL has path info that does not end with a slash' do
+        actual_path_prefix('http://www.example.net/psc').should == '/psc/api/v1'
+      end
+
+      it 'is not appended if it is already there and it ends with a slash' do
+        actual_path_prefix('http://www.example.net/api/v1').should == '/api/v1'
+      end
+
+      it 'is not appended if it is already there and it does not end with a slash' do
+        actual_path_prefix('http://www.example.net/api/v1/').should == '/api/v1'
+      end
+    end
+
+    DEFAULT_MIDDLEWARE_COUNT = 6
+
+    describe 'the default middleware' do
+      it 'has the authentication middleware first' do
+        conn.builder[0].should == Psc::Faraday::HttpBasic
+      end
+
+      it 'has the string-is-xml middleware next' do
+        conn.builder[1].should == Psc::Faraday::StringIsXml
+      end
+
+      it 'has the Faraday JSON request middleware next' do
+        conn.builder[2].should == ::Faraday::Request::JSON
+      end
+
+      it 'has the Faraday URL-encoded request middleware next' do
+        conn.builder[3].should == ::Faraday::Request::UrlEncoded
+      end
+
+      it 'has the FaradayStack XML parser middleware next' do
+        conn.builder[4].should == ::FaradayStack::ResponseXML
+      end
+
+      it 'has the FaradayStack JSON parser middleware next' do
+        conn.builder[5].should == ::FaradayStack::ResponseJSON
+      end
+    end
+
+    describe 'user-specified additional middleware' do
+      let(:custom_conn) {
+        Psc::Connection.new('http://psc.example.org/', options) do |builder|
+          builder.use ::Faraday::Response::Logger
+        end
+      }
+
+      it 'comes after the default middleware' do
+        custom_conn.builder[DEFAULT_MIDDLEWARE_COUNT].should == ::Faraday::Response::Logger
+      end
+
+      it 'comes before the adapter' do
+        custom_conn.builder.handlers.last.should == ::Faraday::Adapter::NetHttp
+      end
+    end
+
+    describe 'selecting authentication middleware' do
+      let(:auth_middleware) { conn.builder[0] } # this is a Faraday::Builder::Handler
+      let(:auth_mw_args)    { conn.builder[0].instance_eval { @args } }
+
+      context 'when :basic' do
+        before do
+          options[:authenticator] = { :basic => %w(foo bar) }
+        end
+
+        it 'uses the HttpBasic middleware' do
+          auth_middleware.klass.should == Psc::Faraday::HttpBasic
+        end
+
+        it 'provides the username and password to the middleware' do
+          auth_mw_args.should == %w(foo bar)
+        end
+      end
+
+      context 'when :token' do
+        before do
+          options[:authenticator] = { :token => lambda { 'foo' } }
+        end
+
+        it 'uses the PscToken middleware' do
+          auth_middleware.klass.should == Psc::Faraday::PscToken
+        end
+
+        it 'provides the token (or creator) to the middleware' do
+          auth_mw_args.first.call.should == 'foo'
+        end
+      end
+
+      context 'when an unknown kind' do
+        before do
+          options[:authenticator] = { :quuxor => 7 }
+        end
+
+        it 'raises an error' do
+          lambda { conn }.should raise_error('Unsupported authentication method :quuxor.')
+        end
+      end
+
+      context 'when :authenticator not specified' do
+        before do
+          options.delete :authenticator
+        end
+
+        it 'raises an error' do
+          lambda { conn }.should raise_error(
+            'No authentication method specified. Please include the :authenticator option.')
+        end
+      end
+    end
+
+    describe 'selecting an adapter' do
+      let(:adapter) { conn.builder.handlers.last }
+
+      it 'defaults to net/http' do
+        adapter.klass.should == ::Faraday::Adapter::NetHttp
+      end
+
+      it 'uses the one the user provides if any' do
+        custom_conn = Connection.new('dc', options) do |builder|
+          builder.adapter :excon
+        end
+        custom_conn.builder.handlers.last.should == ::Faraday::Adapter::Excon
+      end
+    end
+  end
+end

data/spec/psc/faraday/http_basic_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path("../../../spec_helper", __FILE__)
+
+module Psc::Faraday
+  describe HttpBasic do
+    include_context "middleware"
+    it_behaves_like "unconditional middleware"
+
+    subject { HttpBasic.new(app, 'jo', 'basil') }
+
+    it 'adds the appropriate Authorization header' do
+      do_call
+      headers['Authorization'].should == 'Basic am86YmFzaWw='
+    end
+  end
+end

data/spec/psc/faraday/psc_token_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path("../../../spec_helper", __FILE__)
+
+module Psc::Faraday
+  describe PscToken do
+    include_context "middleware"
+
+    describe "with a static token" do
+      it_behaves_like "unconditional middleware"
+
+      subject { PscToken.new(app, 'jo-9') }
+
+      it 'adds the appropriate Authorization header' do
+        do_call
+        headers['Authorization'].should == 'psc_token jo-9'
+      end
+    end
+
+    describe "with a dynamic token" do
+      it_behaves_like "unconditional middleware"
+
+      subject do
+        i = 7
+        PscToken.new(app, lambda { i += 1; i ** 2 })
+      end
+
+      it 'adds the appropriate Authorization header' do
+        do_call
+        headers['Authorization'].should == 'psc_token 64'
+      end
+
+      it 'invokes the lambda for each call' do
+        do_call
+        do_call
+        headers['Authorization'].should == 'psc_token 81'
+      end
+    end
+  end
+end

data/spec/psc/faraday/string_is_xml_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+module Psc::Faraday
+  describe StringIsXml do
+    include_context 'middleware'
+
+    subject { StringIsXml.new(app) }
+
+    before do
+      env[:body] = '<foo/>'
+    end
+
+    it 'treats a string body as text/xml' do
+      do_call
+      headers['Content-Type'].should == 'text/xml'
+    end
+
+    it 'leaves a Hash body alone' do
+      env[:body] = { 'foo' => 'bar' }
+      do_call
+      headers['Content-Type'].should be_nil
+    end
+
+    it 'does nothing if the content type is already set' do
+      headers['Content-Type'] = 'application/vnd.sun.wadl+xml'
+      do_call
+      headers['Content-Type'].should == 'application/vnd.sun.wadl+xml'
+    end
+
+    context 'in the same stack as Faraday::Request::JSON' do
+      let(:conn) do
+        ::Faraday::Connection.new('http://example.org/') do |builder|
+          builder.use StringIsXml
+          builder.use ::Faraday::Request::JSON
+        end
+      end
+
+      it 'sets the content type for a string body' do
+        response = conn.put('dc', '<foo/>')
+        response.env[:request_headers]['Content-Type'].should == 'text/xml'
+      end
+
+      it 'does not interfere with the JSON middleware for a Hash body' do
+        response = conn.put('dc', { 'bar' => 'baz' })
+        response.env[:request_headers]['Content-Type'].should == 'application/json'
+      end
+    end
+  end
+end