foto 0.0.1 → 0.0.2

data/.gitignore

@@ -3,6 +3,8 @@
 .bundle
 .config
 .yardoc
+.rspec
+.rbenv-version
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -12,6 +14,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+tags
 test/tmp
 test/version_tmp
 tmp

data/README.md

@@ -1,6 +1,6 @@
 # Foto
 
-TODO: Write a gem description
+A gem for communicating with the FOTO Patient Inquiry API http://share.patient-inquiry.com.
 
 ## Installation
 
@@ -18,7 +18,39 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configure the gem:
+```ruby
+Foto.configure do |config|
+  config.api_key = '41B4333G-FF2E-41B9-2M24-2G31381D237T'
+  config.base_uri = 'http://devs.patient-inquiry.com'
+end
+```
+
+### Update or create a patient:
+```ruby
+foto_patient = Foto::Patient.new({
+      :first_name    => patient.first_name,
+      :last_name     => patient.last_name,
+      :date_of_birth => patient.birth_date,
+      :email         => patient.email,
+      :gender        => patient.gender,
+      :language      => 'en',
+      :external_id   => patient.id
+    })
+foto_patient.save
+```
+
+### You can also specify an api key per request:
+```ruby
+foto_patient = Foto::Patient.new({
+      :api_key       => '41B4333G-FF2E-41B9-2M24-2G31381D237T',
+      :first_name    => patient.first_name,
+      :last_name     => patient.last_name,
+      ...
+    })
+foto_patient.save
+```
+
 
 ## Contributing
 

data/foto.gemspec

@@ -8,9 +8,14 @@ Gem::Specification.new do |gem|
   gem.version       = Foto::VERSION
   gem.authors       = ["Peter Tran"]
   gem.email         = ["Peter Tran <ptran@optimiscorp.com>"]
-  gem.description   = %q{placeholder}
-  gem.summary       = %q{placeholder}
-  gem.homepage      = ""
+  gem.description   = %q{Provides an interface for communicating with FOTO Patient Inquiry API}
+  gem.summary       = %q{Provides an interface for communicating with FOTO Patient Inquiry API}
+  gem.homepage      = "https://github.com/optimis/foto"
+
+  gem.add_dependency "yajl-ruby"
+  gem.add_dependency "nokogiri"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "webmock"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/foto.rb

@@ -1,5 +1,12 @@
-require "foto/version"
+require 'foto/version'
 
 module Foto
-  # Your code goes here...
+  require 'foto/client'
+  require 'foto/config'
+  require 'foto/consumer'
+  require 'foto/patient'
+  require 'foto/requests/request'
+  require 'foto/requests/response'
+  require 'foto/requests/put'
+  require 'foto/json_date'
 end

data/lib/foto/client.rb

@@ -0,0 +1,15 @@
+require 'foto/config'
+
+module Foto
+  class Client
+    attr_accessor *Foto::Config::VALID_OPTIONS
+
+    def initialize(options={})
+      settings = Foto::Config.options.merge(options)
+
+      Config::VALID_OPTIONS.each do |option|
+        send("#{option}=", settings[option])
+      end
+    end
+  end
+end

data/lib/foto/config.rb

@@ -0,0 +1,28 @@
+module Foto
+
+  def self.configure
+    yield Config
+  end
+
+  module Config
+    module Defaults
+      API_KEY = 'placeholder'
+      BASE_URI = 'http://devs.patient-inquiry.com'
+    end
+
+    extend self
+
+    VALID_OPTIONS = [:api_key, :base_uri]
+
+    attr_accessor *VALID_OPTIONS
+
+    def reset!
+      self.api_key = Defaults::API_KEY
+      self.base_uri = Defaults::BASE_URI
+    end
+
+    def options
+      Hash[ *VALID_OPTIONS.map {|option| [option, send(option)]}.flatten ]
+    end
+  end
+end

data/lib/foto/consumer.rb

@@ -0,0 +1,24 @@
+module Foto
+  class Consumer
+    attr_accessor :api_key
+
+    def self.url
+      raise NotImplementedError.new('You must implement self.url')
+    end
+
+    def initialize(attributes={})
+      attributes.each do |k, v|
+        send("#{k}=", v)
+      end
+    end
+
+    def as_json
+      raise NotImplementedError.new('You must implement as_json')
+    end
+
+    def save
+      put = Foto::Requests::Put.new(self, as_json)
+      put.run
+    end
+  end
+end

data/lib/foto/json_date.rb

@@ -0,0 +1,12 @@
+class Foto::JsonDate
+  attr_accessor :date
+
+  def initialize(date)
+    @date = date
+  end
+
+  def to_json
+    format = "\"\\/Date(%s)\\/\""
+    format % [date.strftime("%s%z")]
+  end
+end

data/lib/foto/patient.rb

@@ -0,0 +1,30 @@
+module Foto
+  class Patient < Foto::Consumer
+    ATTRIBUTES = [ :external_id, :first_name, :last_name,
+      :email, :date_of_birth, :gender, :language ]
+
+    attr_accessor *ATTRIBUTES
+
+    class << self
+      def attributes
+        ATTRIBUTES
+      end
+
+      def url
+        'patient'
+      end
+    end
+
+    def as_json
+      Yajl::Encoder.encode({
+        'FirstName'   => first_name,
+        'LastName'    => last_name,
+        'DateOfBirth' => Foto::JsonDate.new(date_of_birth),
+        'Email'       => email,
+        'Gender'      => gender,
+        'Language'    => language || 'en',
+        'ExternalId'  => external_id
+      })
+    end
+  end
+end

data/lib/foto/requests/put.rb

@@ -0,0 +1,16 @@
+require 'foto/requests/request'
+
+module Foto
+  module Requests
+    class Put < Foto::Requests::Request
+
+      private
+
+      def build_http_request
+        request = Net::HTTP::Put.new(url.request_uri)
+        request.body = body
+        request
+      end
+    end
+  end
+end

data/lib/foto/requests/request.rb

@@ -0,0 +1,68 @@
+module Foto
+  module Requests
+    class Request
+      attr_accessor :relative_url, :body, :consumer
+
+      def initialize(consumer, body = {})
+        @consumer = consumer
+        @relative_url = consumer.class.url
+        @body = body
+      end
+
+      def run
+        send_http_request
+      end
+
+      def url
+        @url ||= build_url
+      end
+
+      private
+
+      def build_http_request
+        raise NotImplementedError.new('You must implement build_request')
+      end
+
+      def http_request
+        @http_request ||= add_headers(build_http_request)
+      end
+
+      def protocol
+        url.scheme
+      end
+
+      def content_length
+        body.length
+      end
+
+      def content_type
+        'text/json'
+      end
+
+      def api_key
+        consumer.api_key || Foto::Config.api_key
+      end
+
+      def add_headers(http_request)
+        http_request.add_field('User-Agent', 'Foto')
+        http_request.add_field('Content-Length', content_length)
+        http_request.add_field('Content-Type', content_type)
+        http_request
+      end
+
+      def send_http_request
+        base_uri = URI(Foto::Config.base_uri)
+        http = Net::HTTP.new(base_uri.host, base_uri.port)
+        http.use_ssl = (protocol === 'https')
+        http.start do |http|
+          Response.new(http.request(http_request))
+        end
+      end
+
+      def build_url
+        format = 'json'
+        URI("#{Foto::Config.base_uri}/#{relative_url}/#{format}/?Api-Key=#{api_key}")
+      end
+    end
+  end
+end

data/lib/foto/requests/response.rb

@@ -0,0 +1,21 @@
+module Foto
+  module Requests
+    class Response
+      attr_reader :body, :code
+
+      def initialize(http_response)
+        @body = http_response.body
+        @code = http_response.code
+      end
+
+      def message
+        doc = Nokogiri::HTML(@body)
+        doc.xpath('/html/body/p').first.content
+      end
+
+      def successful?
+        code == '200'
+      end
+    end
+  end
+end

data/lib/foto/version.rb

@@ -1,3 +1,3 @@
 module Foto
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/foto/client_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Foto::Client do
+  describe '#initialize' do
+    let(:default_options) do
+      { :api_key => 'AAABBBCCC', :base_uri => 'http://a.b.com' }
+    end
+    let(:foto) { Foto::Client.new(default_options) }
+
+    it 'can accept a default options hash' do
+      foto.api_key.should eql(default_options[:api_key])
+      foto.base_uri.should eql(default_options[:base_uri])
+    end
+  end
+end
+
+

data/spec/foto/config_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Foto::Config do
+  let(:config)   { Foto::Config }
+  let(:defaults) { Foto::Config::Defaults }
+
+  before do
+    config.reset!
+  end
+
+  describe '.api_key' do
+    it 'has a default' do
+      config.api_key.should eql(defaults::API_KEY)
+    end
+  end
+
+  describe '.base_uri' do
+    it 'has a default' do
+      config.base_uri.should eql(defaults::BASE_URI)
+    end
+  end
+
+  describe '.reset!' do
+    it 'resets the configuration to their default values' do
+      config.api_key = 'somethingelse'
+      config.api_key.should eql('somethingelse')
+      config.base_uri = 'http://other.com'
+      config.base_uri.should eql('http://other.com')
+      config.reset!
+      config.api_key.should eql(defaults::API_KEY)
+      config.base_uri.should eql(defaults::BASE_URI)
+    end
+  end
+
+  describe '.options' do
+    it 'returns a hash of current options' do
+      config.options.keys.should =~ Foto::Config::VALID_OPTIONS
+    end
+  end
+end
+
+describe Foto do
+  describe '.configure' do
+    Foto::Config::VALID_OPTIONS.each do |option|
+      it "#{option} should be configurable" do
+        Foto.configure do |configuration|
+          configuration.send("#{option}=", option)
+          configuration.send(option).should eql(option)
+        end
+      end
+    end
+  end
+end

data/spec/foto/foto_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Foto do
+  it 'should have a version' do
+    Foto::VERSION.should_not be_nil
+  end
+end
+

data/spec/foto/patient_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Foto::Patient do
+  let(:patient) { Foto::Patient.new }
+  let(:initialized_patient) { Foto::Patient.new(patient_attributes) }
+  let(:patient_attributes) do
+    {
+      :external_id   => 'external_id_test',
+      :first_name    => 'Bob',
+      :last_name     => 'Bobson',
+      :email         => 'bob.bobson@bobbobson.com',
+      :date_of_birth => Time.parse('03/07/1983'),
+      :gender        => 'M',
+      :language      => 'en'
+    }
+  end
+
+  it 'should have accessors for each attribute' do
+    Foto::Patient.attributes.each do |attribute|
+      patient.should respond_to(attribute)
+    end
+  end
+
+  it 'accepts an initial hash of attributes' do
+    patient_attributes.each do |k, v|
+      v.should_not be_nil
+      initialized_patient.send(k).should eql(v)
+    end
+  end
+
+  describe '#as_json' do
+    let(:date_of_birth) { Foto::JsonDate.new(initialized_patient.date_of_birth).to_json }
+    it 'returns a JSON hash of attributes' do
+      Yajl::Parser.parse(initialized_patient.as_json).should == {
+        'FirstName'   => initialized_patient.first_name,
+        'LastName'    => initialized_patient.last_name,
+        'DateOfBirth' => Yajl::Parser.parse(date_of_birth),
+        'Email'       => initialized_patient.email,
+        'Gender'      => initialized_patient.gender,
+        'Language'    => initialized_patient.language,
+        'ExternalId'  => initialized_patient.external_id
+      }
+    end
+  end
+
+  describe '#save' do
+    let(:request) { mock :request }
+    it 'makes a request to FOTO' do
+      Foto::Requests::Put.should_receive(:new).and_return(request)
+      request.should_receive(:run)
+      initialized_patient.save
+    end
+  end
+
+  describe '.url' do
+    it 'returns a partial URL' do
+      patient.class.url.should_not be_nil
+      patient.class.url.should be_an_instance_of(String)
+    end
+  end
+end

data/spec/foto/requests/put_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Foto::Requests::Put do
+  let(:patient) { Foto::Patient.new }
+  let(:url) { Foto::Requests::Put.new(patient).send(:build_url).to_s }
+  let(:body) do
+    {
+      :a => 'a',
+      :b => 'b',
+      :c => 'c'
+    }
+  end
+  let(:error) do
+    %q{
+    <html>
+      <head>
+        <title>Request Error - No API Key</title>
+        <style type="text/css">
+          body
+          {
+            font-family: Verdana;
+            font-size: x-large;
+          }
+        </style>
+      </head>
+      <body>
+        <h1>Request Error</h1>
+        <p>A valid API key needs to be included using the Api-Key query string parameter</p>
+      </body>
+    </html>}
+  end
+
+  describe '#run' do
+    describe 'On success' do
+      it 'makes an HTTP Put request to the correct URL' do
+        stub_request(:put, url)
+        Foto::Requests::Put.new(patient, body).run
+        assert_requested(:put, url)
+      end
+    end
+
+    describe 'On error' do
+      it 'returns an instance of Foto::Requests::Response' do
+        stub_request(:put, url).to_return(:body => error, :status => 401)
+        response = Foto::Requests::Put.new(patient, body).run
+        assert_requested(:put, url)
+        response.message.should eql('A valid API key needs to be included using the Api-Key query string parameter')
+        response.code.should eql('401')
+      end
+    end
+  end
+
+  describe '#url' do
+    let(:api_key) { Foto::Config.api_key }
+    let(:base_uri) { Foto::Config.base_uri }
+    let(:uri) { Foto::Requests::Put.new(patient).send(:build_url) }
+
+    it 'returns a URI::HTTP' do
+      uri.class.should eql(URI::HTTP)
+    end
+
+    it 'has the correct url' do
+      uri.to_s.should eql("#{base_uri}/#{patient.class.url}/json/?Api-Key=#{api_key}")
+    end
+  end
+end

data/spec/foto/requests/response_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Foto::Requests::Response do
+  let(:http_response) do
+    mock :http_response, :body => html, :code => '401'
+  end
+  let(:html) do
+    %q{
+    <html>
+      <head>
+        <title>Request Error - No API Key</title>
+        <style type="text/css">
+          body
+          {
+            font-family: Verdana;
+            font-size: x-large;
+          }
+        </style>
+      </head>
+      <body>
+        <h1>Request Error</h1>
+        <p>A valid API key needs to be included using the Api-Key query string parameter</p>
+      </body>
+    </html>}
+  end
+  let!(:response) { Foto::Requests::Response.new(http_response) }
+
+  describe '#initialize' do
+    it 'sets the appropriate instance variables' do
+      response.body.should eql(html)
+      response.code.should eql('401')
+    end
+  end
+
+  describe '#message' do
+    it 'returns the correct response message' do
+      response.message.should eql('A valid API key needs to be included using the Api-Key query string parameter')
+    end
+  end
+
+  describe 'successful?' do
+    it 'returns true if the request was successful' do
+      response.should_not be_successful
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +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`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'yajl'
+require 'nokogiri'
+require 'foto'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+
+  config.before(:each) do
+    Foto::Config.reset!
+  end
+end

metadata

@@ -1,23 +1,88 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: foto
-version: !ruby/object:Gem::Version
-  version: 0.0.1
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
 platform: ruby
-authors:
+authors: 
 - Peter Tran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-13 00:00:00.000000000 Z
-dependencies: []
-description: placeholder
-email:
+
+date: 2012-12-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Provides an interface for communicating with FOTO Patient Inquiry API
+email: 
 - Peter Tran <ptran@optimiscorp.com>
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - LICENSE.txt
@@ -25,29 +90,61 @@ files:
 - Rakefile
 - foto.gemspec
 - lib/foto.rb
+- lib/foto/client.rb
+- lib/foto/config.rb
+- lib/foto/consumer.rb
+- lib/foto/json_date.rb
+- lib/foto/patient.rb
+- lib/foto/requests/put.rb
+- lib/foto/requests/request.rb
+- lib/foto/requests/response.rb
 - lib/foto/version.rb
-homepage: ''
+- spec/foto/client_spec.rb
+- spec/foto/config_spec.rb
+- spec/foto/foto_spec.rb
+- spec/foto/patient_spec.rb
+- spec/foto/requests/put_spec.rb
+- spec/foto/requests/response_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/optimis/foto
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: placeholder
-test_files: []
+summary: Provides an interface for communicating with FOTO Patient Inquiry API
+test_files: 
+- spec/foto/client_spec.rb
+- spec/foto/config_spec.rb
+- spec/foto/foto_spec.rb
+- spec/foto/patient_spec.rb
+- spec/foto/requests/put_spec.rb
+- spec/foto/requests/response_spec.rb
+- spec/spec_helper.rb
+has_rdoc: