box_view 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDM0ZmZhYjA5OTFmM2NiN2IxYTQ3ZDcyYjJjZTNmZTA2ZDJkZWEzYQ==
+  data.tar.gz: !binary |-
+    NzkzZWU2NWE2ZTc1ZWNlYWU2ZTQyZTk4YmM2ZWIwMmFlMGNhZDQ0Mw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    N2I2OGY2NzAyNzk5MjQxMDNmZmZjZjYzMDBjNTU2YmM4YmM0MGVhZWRlOGZh
+    NmI0NjY5OWM4NWVlMjIxMTNjNzQxZDc4NDE1NGM0Yzg2ZjA3NzYzMTlkMzI1
+    OGQwZDAyZDNmYTgxZjJmZGM4MDI2NDYwYjI3OTNlYTcwYjc1N2M=
+  data.tar.gz: !binary |-
+    ZDJjMjE3YjgwZGZkYzU5Y2VjOThhNTA2ZmY4MDNlM2IxMTAwYzlhNmVkYTkw
+    OTg1NzI2NmY5Y2YyMDVjZGUwYWMxNjdlMjBhY2YxMTMzZWFiMGQ1MDNkMDgw
+    OTJjNmYwOGU0ZjNkNTQ5NDdmY2Y2MmIyYmI3YmNiMWFmYTllZjI=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 reillyforshaw
+
+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,72 @@
+# BoxView
+
+A ruby client for [Box's View API](http://developers.box.com/view/). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'box_view'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install box_view
+
+## Usage
+
+Configure with your Box View API key.
+
+    BoxView::Session.config do |config|
+      config.box_view_token = YOUR_API_KEY
+    end
+
+Or configure a session and pass it to the API when you instatiate it.
+
+    session = BoxView::Session.new(token: YOUR_API_KEY)
+    BoxView::Api::Document.new(session)
+
+Upload a document at a url.
+
+    doc = BoxView::Api::Document.new.upload("http://www.example.com/myfile.pdf", "My File")
+
+Check the document's `status`. When it is "done", you're ready to generate a viewing session.
+
+    doc = doc.reload
+    if doc.status == "done"
+      document_session = doc.document_session
+      view_url = document_session.view_url
+    end
+
+Remove the document from Box View.
+
+    doc.destroy
+
+List all of your Box View documents.
+
+    docs = BoxView::Api::Document.new.list
+
+Generate a thumbnail of a document
+
+    f = File.open("myfile.pdf", 'w')
+    f.write(doc.thumbnail(100, 100))
+    f.flush
+    f.close
+
+Download the conents in pdf or zip format
+
+    f = File.open("myfile.pdf", 'w')
+    f.write(doc.content("pdf"))
+    f.flush
+    f.close
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r box_view.rb"
+end

data/box_view.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'box_view/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "box_view"
+  spec.version       = BoxView::VERSION
+  spec.authors       = ["Reilly Forshaw"]
+  spec.email         = ["reilly.forshaw@goclio.com"]
+  spec.description   = "API client for Box View"
+  spec.summary       = "A ruby library to interact with Box View"
+  spec.homepage      = "https://github.com/reillyforshaw/box_view"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+end

data/lib/box_view/api/actions/crudable.rb

@@ -0,0 +1,20 @@
+module BoxView
+  module Api
+    module Actions
+      module Crudable
+
+        def create(params)
+          data_item(session.post(endpoint_url, session.convert_params(params).to_json), session)
+        end
+
+        def update(id, params)
+          data_item(session.put("#{endpoint_url}/#{id}", session.convert_params(params).to_json), session)
+        end
+
+        def destroy(id)
+          session.delete("#{endpoint_url}/#{id}", false)
+        end
+      end
+    end
+  end
+end

data/lib/box_view/api/actions/findable.rb

@@ -0,0 +1,12 @@
+module BoxView
+  module Api
+    module Actions
+      module Findable
+
+        def find(id)
+          data_item(session.get("#{endpoint_url}/#{id}"), session)
+        end
+      end
+    end
+  end
+end

data/lib/box_view/api/actions/listable.rb

@@ -0,0 +1,12 @@
+module BoxView
+  module Api
+    module Actions
+      module Listable
+
+        def list(params={})
+          session.get(endpoint_url, params)["document_collection"]["entries"].collect{ |item| data_item(item, session) }
+        end
+      end
+    end
+  end
+end

data/lib/box_view/api/base.rb

@@ -0,0 +1,22 @@
+module BoxView
+  module Api
+    class Base
+
+      attr_accessor :session
+
+      def initialize(session=nil)
+        self.session = session || BoxView::Session.new
+      end
+
+      private
+
+      def data_item(params, session)
+        data_klass.new(params, session)
+      end
+
+      def data_klass
+        raise NotImplementedError.new
+      end
+    end
+  end
+end

data/lib/box_view/api/document.rb

@@ -0,0 +1,47 @@
+module BoxView
+  module Api
+    class Document < Base
+
+      include BoxView::Api::Actions::Findable
+      include BoxView::Api::Actions::Listable
+      include BoxView::Api::Actions::Crudable
+
+      def self.supported_filetypes
+        [:pdf, :doc, :docx, :ppt, :pptx]
+      end
+
+      def self.supported_filetype?(filetype)
+        supported_filetypes.include?(filetype.to_sym)
+      end
+
+      def create(*args)
+        raise NotImplementedError
+      end
+
+      def upload(url, name)
+        data_item(session.post(endpoint_url, { url: url, name: name }.to_json), session)
+      end
+
+      def thumbnail(id, width, height)
+        session.get("#{endpoint_url}/#{id}/thumbnail", { width: width, height: height }, false)
+      end
+
+      def content(id, extension=nil)
+        supported_extensions = %w(zip pdf)
+        raise ArgumentError.new("Unsupported content extension #{extension}. Must use one of #{supported_extensions} or nil.") unless supported_extensions.include?(extension) || extension.nil?
+
+        extension = ".#{extension}" if extension
+        session.get("#{endpoint_url}/#{id}/content#{extension}", {}, false)
+      end
+
+      private
+
+      def data_klass
+        BoxView::Models::Document
+      end
+
+      def endpoint_url; "documents"; end
+
+    end
+  end
+end

data/lib/box_view/api/document_session.rb

@@ -0,0 +1,25 @@
+module BoxView
+  module Api
+    class DocumentSession < Base
+
+      include BoxView::Api::Actions::Crudable
+
+      def update(*args)
+        raise NotImplementedError
+      end
+
+      def destroy(*args)
+        raise NotImplementedError
+      end
+
+      private
+
+      def data_klass
+        BoxView::Models::DocumentSession
+      end
+
+      def endpoint_url; "sessions"; end
+
+    end
+  end
+end

data/lib/box_view/http.rb

@@ -0,0 +1,80 @@
+module BoxView
+  module Http
+
+    require 'time'
+    
+    def base_uri(path, params = {})
+      uri = URI.parse("https://view-api.box.com")
+      uri.path = path
+      uri.query = URI.encode_www_form(convert_params(params)) if params.any?
+      uri
+    end
+
+    def get(path, params={}, parse=true)
+      uri = base_uri("#{api_prefix}/#{path}", params)
+      req = Net::HTTP::Get.new(uri.to_s)
+      make_api_request(req, uri, parse)
+    end
+
+
+    def post(path, body="", parse=true)
+      uri = base_uri("#{api_prefix}/#{path}")
+      req = Net::HTTP::Post.new(uri.request_uri)
+      req.body = body
+      req.add_field("Content-Type", "application/json")
+      make_api_request(req, uri, parse)
+    end
+
+    def put(path, body="", parse=true)
+      uri = base_uri("#{api_prefix}/#{path}")
+      req = Net::HTTP::Put.new(uri.request_uri)
+      req.body = body
+      req.add_field("Content-Type", "application/json")
+      make_api_request(req, uri, parse)
+    end
+
+    def delete(path, parse=true)
+      uri = base_uri("#{api_prefix}/#{path}")
+      req = Net::HTTP::Delete.new(uri.request_uri)
+      make_api_request(req, uri, parse)
+    end
+
+    def make_api_request(req, uri, parse=true)
+      puts "BoxView::Http#make_api_request token not availble #{uri}" if self.token.nil? || self.token.empty?
+      return if self.token.nil? || self.token.empty?
+      req.add_field("Authorization", "Token #{self.token}")
+      make_request(req, uri, parse)
+    end
+
+    def make_request(req, uri, parse=true)
+      req.add_field("Accept", "text/json")
+      n = Net::HTTP.new(uri.host, uri.port)
+      n.use_ssl = true
+      res = n.start do |http|
+        http.request(req)
+      end
+      puts "BoxView::Http#make_request #{uri} response: #{res.body}#{" Parsing" if parse}"
+      parse_response(res, parse)
+    end
+
+    def parse_response(res, parse=true)
+      parse ? JSON.parse(res.body) : res.body
+    end
+
+    def convert_params(params)
+      params.each_pair do |key, val|
+        if [Date, Time, DateTime].include?(val.class)
+          params[key] = val.iso8601
+        end
+      end
+      params
+    end
+
+    private
+
+    def api_prefix()
+      "/1"
+    end
+
+  end
+end

data/lib/box_view/models/base.rb

@@ -0,0 +1,86 @@
+module BoxView
+  module Models
+
+    class ReadOnlyAttribute < Exception; end
+    class ResourceNotSaved < Exception; end
+    
+    class Base
+
+      require 'time'
+
+      attr_accessor :session
+
+      def initialize(fields = {}, session = nil)
+        self.session = session
+        fields.each_pair do |k, v|
+          self.send("#{k}=", v) if self.respond_to?("#{k}=") && !v.nil?
+        end
+      end
+
+      def write_attribute(name, value)
+        instance_variable_set("@#{name}", value)
+      end
+
+      def reload
+        raise ResourceNotSaved.new if self.id.nil?
+        api.find(self.id)
+      end
+
+      def save
+        if self.id.nil?
+          created_item = api.create(self.to_params)
+          self.id = created_item && created_item.id
+          self
+        else
+          api.update(self.id, self.to_params)
+          self
+        end
+      end
+
+      def destroy
+        raise ResourceNotSaved.new if self.id.nil?
+        api.destroy(self.id)
+      end
+
+      def api
+        raise NotImplementedError.new
+      end
+
+      def to_params
+        raise NotImplementedError.new
+      end
+
+      class << self
+        def has_attributes(attributes)
+          attributes.each_pair do |name, options|
+            attr_reader name
+            define_method "#{name}=" do |value|
+              if options[:readonly] && !instance_variable_get("@#{name}").nil?
+                raise ReadOnlyAttribute.new(name)
+              end
+              write_attribute(name, self.class.convert_attribute(value, options[:type]))
+            end
+          end
+        end
+
+        def convert_attribute(value, type)
+          case type
+          when :date
+            (value.is_a?(Time) || value.is_a?(DateTime)) ? value.to_date : Date.parse(value)
+          when :time
+            (value.is_a?(Date) || value.is_a?(DateTime)) ? value.to_time : Time.parse(value)
+          when :datetime
+            (value.is_a?(Date) || value.is_a?(Time)) ? value.to_datetime : DateTime.parse(value)
+          when :integer
+            value.to_i
+          when :string
+            value.to_s
+          else
+            value
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/box_view/models/document.rb

@@ -0,0 +1,36 @@
+module BoxView
+  module Models
+    class Document < Base
+
+      has_attributes(
+        type:        { type: :string },
+        id:          { type: :string },
+        status:      { type: :string },
+        name:        { type: :name },
+        created_at:  { type: :datetime, readonly: true },
+        modified_at: { type: :datetime, readonly: true }
+      )
+
+      def document_session
+        @document_session ||= BoxView::Api::DocumentSession.new(session).create(document_id: self.id)
+      end
+
+      def thumbnail(width, height)
+        self.api.thumbnail(self.id, width, height)
+      end
+
+      def content(extension=nil)
+        self.api.content(self.id, extension)
+      end
+
+      def to_params
+        { name: self.name }
+      end
+
+      def api
+        @api ||= BoxView::Api::Document.new(session)
+      end
+
+    end
+  end
+end

data/lib/box_view/models/document_session.rb

@@ -0,0 +1,26 @@
+module BoxView
+  module Models
+    class DocumentSession < Base
+      
+      has_attributes(
+        type:       { type: :string },
+        id:         { type: :string },
+        expires_at: { type: :datetime, readonly: true }
+      )
+
+      def view_url(theme = "dark")
+        return nil if self.id.nil?
+        "https://view-api.box.com/view/#{self.id}?theme=#{theme}"
+      end
+
+      def to_params
+        {}
+      end
+
+      def api
+        @api ||= BoxView::Api::DocumentSession.new(session)
+      end
+
+    end
+  end
+end

data/lib/box_view/session.rb

@@ -0,0 +1,21 @@
+module BoxView
+  class Session
+
+    include Http
+
+    attr_accessor :token
+    
+    def initialize(credentials={})
+      self.token = credentials[:token] || self.class.box_view_token
+    end
+
+    class << self
+      attr_accessor :box_view_token
+
+      def config
+        yield self
+      end
+    end
+
+  end
+end

data/lib/box_view/version.rb

@@ -0,0 +1,3 @@
+module BoxView
+  VERSION = "0.0.1"
+end

data/lib/box_view.rb

@@ -0,0 +1,43 @@
+require "box_view/version"
+
+require "net/http"
+require "json"
+
+module BoxView
+  {
+    Session: 'session',
+    Http:    'http'
+  }.each_pair do |klass, file|
+    autoload klass, "box_view/#{file}"
+  end
+
+  module Models
+    {
+      Base:            'base',
+      Document:        'document',
+      DocumentSession: 'document_session'
+    }.each_pair do |klass, file|
+      autoload klass, "box_view/models/#{file}"
+    end
+  end
+
+  module Api
+    {
+      Base:            'base',
+      Document:        'document',
+      DocumentSession: 'document_session'
+    }.each_pair do |klass, file|
+      autoload klass, "box_view/api/#{file}"
+    end
+
+    module Actions
+      {
+        Crudable: 'crudable',
+        Findable: 'findable',
+        Listable: 'listable'
+      }.each_pair do |klass, file|
+        autoload klass, "box_view/api/actions/#{file}"
+      end
+    end
+  end
+end

data/spec/api/actions/crudable_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe BoxView::Api::Actions::Crudable do
+  let(:session) { double("BoxView::Api::Actions::Crudable") }
+  let(:params) { { text: "1" } }
+  let(:subject) {
+    d = DummyApi.new(session)
+    d.extend(BoxView::Api::Actions::Crudable)
+    d
+  }
+  let(:response) { { id: 1, text: "1"} }
+  before { session.stub(:convert_params).and_return(params) }
+
+  describe "#create" do
+    it "should send a create request" do
+      session.stub(:post).with("dummies", params.to_json).and_return(response)
+      record = subject.create(params)
+      expect(record).to be_kind_of(DummyResource)
+      expect(record.id).to eql(1)
+    end
+  end
+
+  describe "#update" do
+    it "should send an update request" do
+      session.stub(:put).with("dummies/1", params.to_json).and_return(response)
+      record = subject.update(1, params)
+      expect(record).to be_kind_of(DummyResource)
+      expect(record.id).to eql(1)
+    end
+  end
+
+  describe "#destroy" do
+    it "should send a delete request" do
+      session.should_receive(:delete)
+      subject.destroy(1)
+    end
+  end
+end

data/spec/api/actions/findable_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe BoxView::Api::Actions::Findable do
+  let(:session) { double("BoxView::Api::Actions::Findable") }
+  let(:subject) {
+    d = DummyApi.new(session)
+    d.extend(BoxView::Api::Actions::Findable)
+    d
+  }
+
+  describe "#find" do
+    let(:response) do
+      { id: 1 }
+    end
+
+    it "should return the correct data item" do
+      session.stub(:get).and_return(response)
+      record = subject.find(1)
+      expect(record).to be_kind_of(DummyResource)
+      expect(record.id).to eql(1)
+    end
+  end
+end

data/spec/api/actions/listable_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe BoxView::Api::Actions::Listable do
+  let(:session) { double("BoxView::Api::Actions::Listable") }
+  let(:subject) {
+    d = DummyApi.new(session)
+    d.extend(BoxView::Api::Actions::Listable)
+    d
+  }
+
+  describe "#list" do
+    let(:response) do
+      { "document_collection" => { "entries" => [{ id: 1 }, { id: 2 }] } }
+    end
+
+    it "should return the correct data items" do
+      session.stub(:get).and_return(response)
+      records = subject.list
+      expect(records.count).to eql(2)
+      expect(records.first).to be_kind_of(DummyResource)
+      expect(records.first.id).to eql(1)
+      expect(records.last.id).to eql(2)
+    end
+  end
+
+end

data/spec/api/base_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe BoxView::Api::Base do
+  let(:api) { BoxView::Api::Base.new(session) }
+  let(:session) { nil }
+
+  it "should ues the configured session" do
+    expect(api.session).to_not be_nil
+  end
+
+  context "when a session is suppied" do
+    let(:session) { "the session" }
+
+    it "should use the supplied session" do
+      expect(api.session).to eql(session)
+    end
+  end
+end

data/spec/api/document_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe BoxView::Api::Document do
+  let(:session) { double("BoxView::Api::Session") }
+  let(:url) { "http://www.example.com/1.pdf" }
+  let(:name) { "Doc 1" }
+  let(:params) { { url: url, name: name } }
+  let(:subject) { BoxView::Api::Document.new(session) }
+  
+  describe "#upload" do
+    let(:response) { { id: "1" } }
+
+    it "should send a post request" do
+      session.stub(:post).with("documents", params.to_json).and_return(response)
+      record = subject.upload(url, name)
+      expect(record).to be_kind_of(BoxView::Models::Document)
+      expect(record.id).to eql("1")
+    end
+  end
+
+  describe "#content" do
+    context "filename has invalid extension" do
+      it "should raise an ArgumentError" do
+        expect{subject.content("1", "foo.bar")}.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/models/base_spec.rb

@@ -0,0 +1,206 @@
+require 'spec_helper.rb'
+
+describe BoxView::Models::Base do
+  let(:model) { BoxView::Models::Base.new(fields, session) }
+  let(:fields) { {} }
+  let(:session) { nil }
+
+  before {
+    model.stub(:api).and_return(BoxView::Api::Base.new)
+    model.stub(:to_params).and_return({})
+    model.stub(:id).and_return(1)
+  }
+
+  describe "#reload" do
+    context "when the resource is not saved" do
+      before { model.stub(:id) }
+      it "should raise ResourceNotSaved" do
+        expect{model.reload}.to raise_error(BoxView::Models::ResourceNotSaved)
+      end
+    end
+
+    it "should use the api's find method" do
+      model.api.should_receive(:find)
+      model.reload
+    end
+  end
+
+  describe "#save" do
+    context "when the resource is not saved" do
+      before {
+        model.stub(:id)
+        model.api.stub(:create).and_return(double("BoxView::Models::Base", id: 1))
+      }
+      it "should use the api's create method" do
+        model.api.should_receive(:create)
+        model.should_receive(:id=)
+        model.save
+      end
+    end
+
+    it "should use the api's update method" do
+      model.api.should_receive(:update)
+      model.save
+    end
+  end
+
+  describe "#destroy" do
+    context "when the resource is not saved" do
+      before { model.stub(:id) }
+      it "should raise ResourceNotSaved" do
+        expect{model.destroy}.to raise_error(BoxView::Models::ResourceNotSaved)
+      end
+    end
+
+    it "should use the api's destroy method" do
+      model.api.should_receive(:destroy)
+      model.destroy
+    end
+  end
+
+  describe ".has_attributes" do
+    before do
+      BoxView::Models::Base.has_attributes(
+        foo: { type: :string, readonly: true },
+        bar: { type: :string }
+      )
+    end
+    let(:model) { BoxView::Models::Base.new({foo: "foo"}) }
+
+    it "should define getter for the given attributes" do
+      model.should respond_to :foo
+    end
+
+    it "should define setter for the given attributes" do
+      model.should respond_to :foo=
+    end
+
+    context "when an attribute is readonly" do
+      it "should create setter that throws an exception" do
+        expect{model.foo = "bar"}.to raise_error(BoxView::Models::ReadOnlyAttribute)
+      end
+    end
+
+    it "should convert the attribute when setting it" do
+      BoxView::Models::Base.should_receive :convert_attribute
+      model.bar = "bar"
+    end
+  end
+
+  describe ".convert_attribute" do
+    let(:result) { BoxView::Models::Base.convert_attribute(value, type) }
+
+    context "when type is date" do
+      let(:type) { :date }
+      let(:value) { "2014-02-11" }
+      
+      context "when value is a Time" do
+        let(:value) { Time.new }
+        
+        it "should call to_date on the value" do
+          value.should_receive(:to_date)
+          result
+        end
+      end
+
+      context "when value is a DateTime" do
+        let(:value) { DateTime.new }
+        
+        it "should call to_date on the value" do
+          value.should_receive(:to_date)
+          result
+        end
+      end
+
+      it "should parse the value" do
+        Date.should_receive(:parse).with(value)
+        result
+      end
+    end
+
+    context "when type is time" do
+      let(:type) { :time }
+      let(:value) { "15:00:00" }
+      
+      context "when value is a Date" do
+        let(:value) { Date.new }
+        
+        it "should call to_time on the value" do
+          value.should_receive(:to_time)
+          result
+        end
+      end
+
+      context "when value is a DateTime" do
+        let(:value) { DateTime.new }
+        
+        it "should call to_time on the value" do
+          value.should_receive(:to_time)
+          result
+        end
+      end
+
+      it "should parse the value" do
+        Time.should_receive(:parse).with(value)
+        result
+      end
+    end
+
+    context "when type is datetime" do
+      let(:type) { :datetime }
+      let(:value) { "15:00:00" }
+      
+      context "when value is a Date" do
+        let(:value) { Date.new }
+        
+        it "should call to_datetime on the value" do
+          value.should_receive(:to_datetime)
+          result
+        end
+      end
+
+      context "when value is a DateTime" do
+        let(:value) { DateTime.new }
+        
+        it "should call to_datetime on the value" do
+          value.should_receive(:to_datetime)
+          result
+        end
+      end
+
+      it "should parse the value" do
+        DateTime.should_receive(:parse).with(value)
+        result
+      end
+    end
+
+    context "when type is integer" do
+      let(:type) { :integer }
+      let(:value) { "42" }
+      
+      it "should convert the value to an integer" do
+        expect(result).to eql(42)
+      end
+    end
+
+    context "when type is string" do
+      let(:type) { :string }
+      let(:value) { 42 }
+      
+      it "should convert the value to a string" do
+        expect(result).to eql("42")
+      end
+    end
+
+    context "when type is anything else" do
+      let(:type) { :foo }
+      let(:value) { [1, 2, 3] }
+      
+      it "should pass the value through" do
+        expect(result).to eql(value)
+      end
+
+    end
+  end
+
+end

data/spec/models/document_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe BoxView::Models::Document do
+  let(:document) { BoxView::Models::Document.new }
+  let(:api) { BoxView::Api::Document.new }
+  before { document.stub(:api).and_return(api) }
+
+  describe "#document_session" do
+    before do
+      BoxView::Api::DocumentSession.any_instance.stub(:create).and_return(BoxView::Models::DocumentSession.new)
+    end
+
+    context "when a document session has already been created" do
+      before do
+        document.instance_variable_set("@document_session", BoxView::Models::DocumentSession.new)
+      end
+
+      it "should not use DocumentSession api's create method" do
+        BoxView::Api::DocumentSession.any_instance.should_not_receive(:create)
+        document.document_session
+      end
+    end
+
+    it "should use DocumentSession api's create method" do
+      BoxView::Api::DocumentSession.any_instance.should_receive(:create)
+      document.document_session
+    end
+  end
+
+  describe "#thumbnail" do
+    before { document.api.stub(:thumbnail) }
+    it "should use the api's thumbnail method" do
+      document.api.should receive(:thumbnail)
+      document.thumbnail(100, 100)
+    end
+  end
+
+  describe "#content" do
+    before { document.api.stub(:content) }
+    it "should use the api's content method" do
+      document.api.should receive(:content)
+      document.content
+    end
+  end
+end

data/spec/session_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe BoxView::Session do
+  let(:session) { BoxView::Session.new(credentials) }
+  let(:credentials) { {} }
+  let(:config_token) { "ABC123" }
+  before { BoxView::Session.config { |config| config.box_view_token = config_token } }
+
+  it "should pick up the configured token" do
+    expect(session.token).to eql(config_token)
+  end
+
+  context "when credentials are supplied" do
+    let(:credentials) { { token: override_token } }
+    let(:override_token) { "overridden token" }
+
+    it "should use supplied token" do
+      expect(session.token).to eql(override_token)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'box_view'
+
+require 'support/dummy_api'
+require 'support/dummy_resource'

data/spec/support/dummy_api.rb

@@ -0,0 +1,9 @@
+class DummyApi < BoxView::Api::Base
+  
+  def data_klass
+    DummyResource
+  end
+
+  def endpoint_url; "dummies"; end
+  
+end

data/spec/support/dummy_resource.rb

@@ -0,0 +1,16 @@
+class DummyResource < BoxView::Models::Base
+
+  has_attributes(
+    id: { type: :integer },
+    text: { type: :string }
+  )
+
+  def to_params
+    { text: self.text }
+  end
+
+  def api
+    @api ||= DummyApi.new(session)
+  end
+
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: box_view
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Reilly Forshaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: API client for Box View
+email:
+- reilly.forshaw@goclio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- box_view.gemspec
+- lib/box_view.rb
+- lib/box_view/api/actions/crudable.rb
+- lib/box_view/api/actions/findable.rb
+- lib/box_view/api/actions/listable.rb
+- lib/box_view/api/base.rb
+- lib/box_view/api/document.rb
+- lib/box_view/api/document_session.rb
+- lib/box_view/http.rb
+- lib/box_view/models/base.rb
+- lib/box_view/models/document.rb
+- lib/box_view/models/document_session.rb
+- lib/box_view/session.rb
+- lib/box_view/version.rb
+- spec/api/actions/crudable_spec.rb
+- spec/api/actions/findable_spec.rb
+- spec/api/actions/listable_spec.rb
+- spec/api/base_spec.rb
+- spec/api/document_spec.rb
+- spec/models/base_spec.rb
+- spec/models/document_spec.rb
+- spec/session_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_api.rb
+- spec/support/dummy_resource.rb
+homepage: https://github.com/reillyforshaw/box_view
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A ruby library to interact with Box View
+test_files:
+- spec/api/actions/crudable_spec.rb
+- spec/api/actions/findable_spec.rb
+- spec/api/actions/listable_spec.rb
+- spec/api/base_spec.rb
+- spec/api/document_spec.rb
+- spec/models/base_spec.rb
+- spec/models/document_spec.rb
+- spec/session_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_api.rb
+- spec/support/dummy_resource.rb