layervault 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3b3c597c5f9ea686f645318bfc78bfbfbe1e5b0
+  data.tar.gz: bc04212e9747011fe20fb05a8fe88948a957ff64
+SHA512:
+  metadata.gz: 6831520fc7291294398f9435fd204aa560e8fd1837681733ca7462eab46e9eb8bb7f2648e5907d313978c593700562710395dbe0a5f0aa4179fc3262e227d21c
+  data.tar.gz: 4292f9681e83d9369c9a0f2e6d10da1bc65394961a5f0671c38dbd9944b8d86d15ebefdf887999ed6a73dddd10be1d2bcc91fecbe236bf6ad78c9ca5bbec4656

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 layervault_ruby_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 John McDowall
+
+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,151 @@
+# LayerVault Ruby API Client
+
+This is the Ruby client library that wraps the [LayerVault API](https://github.com/layervault/api). It assumes you have used another oAuth 2 library to obtain and manage a valid access token.
+
+## Installation
+
+Put this in your Gemfile and smoke it:
+
+```ruby
+gem 'layervault'
+```
+
+Or install it:
+
+```shell
+$ gem install layervault
+```
+
+## Supported oAuth flows
+
+Currently only [Resource Owner Credentials](https://github.com/applicake/doorkeeper/wiki/Using-Resource-Owner-Password-Credentials-flow) and [Client Credentials](https://github.com/applicake/doorkeeper/wiki/Client-Credentials-flow) are supported. Client credentials are pretty much useless as 99% of the API requires a User as context for the operations.
+
+## Requesting an Access Token
+
+1. Register or choose an application from https://layervault.com/oauth/applications/ and note the `client_id` and `client_secret`.
+2. Plug those values into the following curl snippet, including your LayerVault username and password:
+
+```
+curl -i https://api.layervault.com/oauth/token \
+  -F grant_type="password" \
+  -F username="<username_goes_here>" \
+  -F password="<password_goes_here>" \
+  -F client_id="<client_id_goes_here>" \
+  -F client_secret="<client_secret_goes_here>"
+```
+3. You now have an access token. You can make API requests by calling via CURL like so:
+
+```
+curl -H 'Authorization: Bearer <your access token>' \
+  'https://api.layervault.com/api/v1/me'
+```
+
+## Initializing the Client
+
+You can initialize the client via Environment Variables or by passing configurations options into the client when you create it, like this:
+
+    @client = LayerVault::Client.new(access_token: 'your_access_token', api_endpoint: 'your_api_endpoint')
+
+Or you can also say:
+
+    LayerVault.client.access_token = 'access_token'
+    LayerVault.client.api_endpoint = 'api_endpoint'
+
+### Environment Variables
+
+    ENV['LAYERVAULT_ACCESS_TOKEN'] - You LayerVault API access token
+    ENV['LAYERVAULT_API_ENDPOINT'] - The API Endpoint you wish to target calls against (defaults to `https://api.layervault.com/api/v1/`)
+    ENV['LAYERVAULT_USER_AGENT'] - Defaults to `LayerVault Ruby Gem #{LayerVault::VERSION}`
+
+### The User Agent
+
+You should set the User agent to include your email address so that in the event your client does something wrong we can contact you.
+
+## Making API calls
+
+You can use the `LayerVault.client.<api_operation>` methods to call the API to perform actions. Alternatively, each API object has simple object model that allows you to say:
+
+```
+  LayerVault.client.access_token = 'access_token'
+  p = LayerVault::Organization.for('layervault')
+  p.create_project('my new project')
+```
+
+And so on.
+
+### Simple Object Model
+
+There's a very simple object model provided by classes that implement [Hashie](https://github.com/intridea/hashie) objects that wrap the JSON responses from the ```LayerVault.client``` interface. The objects mostly all follow a ```.for``` pattern that accepts the appropriate number of arguments for the level of nesting the object represents. For example,
+
+  - Organizations require the name of the organization: ```Organization.for('layervault')```
+  - Projects require the name of the organization and the project name: ```Project.for('layervault', 'Designer News')```
+  - ... and so on ...
+
+#### Associations
+
+When using the simple object model, associations will be hydrated into the correct child objects allowing a simple level of traversal down the object model hierarchy.
+
+## Access Tokens
+
+Access Tokens are valid for two hours only. When you request a token, you are also told how long the token is valid for, in seconds, as part of the token response:
+
+    {
+      "access_token": "aec9c670cf5e673bfedf83d055d2a2e0e5f37e52d3b41cffcf7874f73a7458bf",
+      "token_type": "bearer",
+      "expires_in": 7200,
+      "refresh_token": "afe9c670cf5e673bfedf83d055d2a2e0e5f37e52d3b41cffcf7874f73a7458bf",
+      "scope": "user"
+    }
+
+Here we can see that the Token is valid for 7200 more seconds, or two hours.
+
+The API implements [Refresh Tokens](https://github.com/applicake/doorkeeper/wiki/Enable-Refresh-Token-Credentials) which allow you to request new tokens without re-authenticating the user through the Web credentials flow. You can see in the access token response above, a refresh_token was given for use in future calls. Store it, use it.
+
+## Omniauth Strategy
+
+If you're looking for something that makes a Rails integration more easy, we've made an [Omniauth Authentication Strategy](https://github.com/layervault/omniauth-layervault).
+
+## Running the test suite.
+
+You should create a test project called ```api-playground``` in your Organization. and make sure ```TEST_ORG``` and ```TEST_PROJECT``` environment variables are set correctly in the call below:
+
+```TEST_ORG='layervault-test' TEST_PROJECT='api-playground' LAYERVAULT_API_ENDPOINT='https://api.layervault.com/api/v1/' LAYERVAULT_ACCESS_TOKEN=<your_access_token> be rspec spec/layervault/client ```
+
+The test suite uses VCR to save making requests against the server. You always have the option of deleting the contents of the ```spec/cassettes``` folder to make real calls against the LayerVault servers.
+
+## Client Methods Summary
+
+### General
+  - LayerVault.client.me
+
+### Organizations
+
+  - LayerVault.client.organization( organization_name )
+
+### Projects
+  - LayerVault.client.project( organization_name, project )
+  - LayerVault.client.create_project( organization_name, project )
+  - LayerVault.client.delete_project( organization_name, project )
+  - LayerVault.client.move_project( organization_name, project, to )
+  - LayerVault.client.change_project_folder_color( organization_name, project, color )
+
+### Folders
+  - LayerVault.client.folder( organization_name, project, folder_path )
+  - LayerVault.client.create_folder( organization_name, project, folder_path )
+  - LayerVault.client.delete_folder( organization_name, project, folder_path )
+  - LayerVault.client.move_folder( organization_name, project, folder_path, new_folder )
+  - LayerVault.client.change_folder_color( organization_name, project, folder_path, color )
+
+### Files
+  - LayerVault.client.file( organization_name, project, folder_path, file_name )
+  - LayerVault.client.create_file( organization_name, project, folder_path, file_name, options )
+  - LayerVault.client.delete_file( organization_name, project, folder_path, file_name )
+  - LayerVault.client.move_file( organization_name, project, folder_path, new_folder, new_filename )
+  - LayerVault.client.sync_check( organization_name, project, folder_path, options )
+
+### Revisions
+  - LayerVault.client.revision( organization_name, project, folder_path, file_name, revision )
+  - LayerVault.client.previews( organization_name, project, folder_path, file_name, revision, options )
+  - LayerVault.client.revisions( organization_name, project, folder_path, file_name, revision, options )
+  - LayerVault.client.meta( organization_name, project, folder_path, file_name, revision )
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/layervault.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'layervault/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "layervault"
+  spec.version       = LayerVault::VERSION
+  spec.authors       = ["John McDowall", "Ryan LeFevre", "Kelly Sutton"]
+  spec.email         = ["john@mcdowall.info", "ryan@layervault.com", "kelly@layervault.com"]
+  spec.description   = %q{The LayerVault Ruby API client.}
+  spec.summary       = %q{Provides Ruby native wrappers for the LayerVault API.}
+  spec.homepage      = ""
+  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_dependency "faraday"
+  spec.add_dependency "hashie"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "multi_json"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock", "1.13"
+end

data/lib/layervault.rb

@@ -0,0 +1,16 @@
+require "layervault/version"
+require "layervault/client"
+require "layervault/mixins/configurable"
+require "layervault/default_options"
+
+module LayerVault
+  class << self
+    include LayerVault::Configurable
+
+    def client 
+      @client ||= LayerVault::Client.new(options)
+    end
+  end
+end
+
+LayerVault.setup

data/lib/layervault/client.rb

@@ -0,0 +1,62 @@
+require 'faraday'
+require 'multi_json'
+
+require 'layervault/mixins/authentication'
+require 'layervault/mixins/configurable'
+require 'layervault/mixins/connection'
+
+require 'layervault/client/users'
+require 'layervault/client/organizations'
+require 'layervault/client/projects'
+require 'layervault/client/folders'
+require 'layervault/client/files'
+require 'layervault/client/revisions'
+
+require 'layervault/model'
+require 'layervault/organization'
+require 'layervault/user'
+require 'layervault/project'
+require 'layervault/folder'
+require 'layervault/file'
+require 'layervault/revision'
+
+module LayerVault
+
+  class ClientParamsError < Exception ; end
+
+  class Client
+    include LayerVault::Authentication
+    include LayerVault::Configurable
+    include LayerVault::Connection
+
+    include LayerVault::Client::Users
+    include LayerVault::Client::Organizations
+    include LayerVault::Client::Projects
+    include LayerVault::Client::Folders
+    include LayerVault::Client::Files
+    include LayerVault::Client::Revisions
+
+    def initialize(options={})
+      LayerVault::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || LayerVault.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+    def get(url, options = {})
+      request :get, url, options
+    end
+
+    def post(url, options = {})
+      request :post, url, options
+    end
+
+    def put(url, options = {})
+      request :put, url, options
+    end
+
+    def delete(url, options = {})
+      request :delete, url, options
+    end
+
+  end
+end

data/lib/layervault/client/files.rb

@@ -0,0 +1,64 @@
+require 'multi_json'
+require 'digest/md5'
+require 'uri'
+
+module LayerVault
+  class Client
+    module Files
+      def file(organization_name, project_name, path, file_name)
+        get "#{organization_name}/#{project_name}/#{path}/#{file_name}"
+      end
+
+      def delete_file(organization_name, project_name, path, file_name, options={})
+        raise ClientParamsError.new("You must specify the md5 option of the file you are trying to delete.") unless options.fetch(:md5, nil)
+        delete "#{organization_name}/#{project_name}/#{path}/#{file_name}", options
+      end
+
+      def create_file(organization_name, project_name, path, file_name, options={} )
+        raise ClientParamsError.new("You must specify the local_file_path option to the file you want to upload.") unless options.fetch(:local_file_path, nil)
+        raise ClientParamsError.new("You must specify the content_type option to the content type of the file you are uploading.") unless options.fetch(:content_type, nil)
+
+        local_file_path = options.fetch(:local_file_path, nil)
+        content_type    = options.fetch(:content_type, nil)
+
+        md5 = Digest::MD5.hexdigest(::File.read(local_file_path))
+        options = {md5: md5}
+
+        json_response = put("#{organization_name}/#{project_name}/#{path}/#{file_name}", options)
+
+        s3_response = MultiJson.decode(json_response)
+        s3_response.merge!( "Content-Type" => content_type)
+
+        payload = s3_response.merge({ file: Faraday::UploadIO.new(local_file_path, content_type) })
+
+        conn = Faraday.new('https://omnivore-scratch.s3.amazonaws.com') do |f|
+          f.request :multipart
+          f.request :url_encoded
+          f.adapter :net_http # This is what ended up making it work
+        end
+
+        response_from_s3 = conn.post('/', payload)
+        redirect = response_from_s3[:location]
+
+        # Add the access_token to the query
+        uri = URI.parse(redirect)
+        new_query_ar = URI.decode_www_form(uri.query) << ["access_token", LayerVault.client.access_token]
+        uri.query = URI.encode_www_form(new_query_ar)
+
+        re = conn.post( uri.to_s )
+      end
+
+      def move_file(organization_name, project_name, path, file_name, options={})
+        raise ClientParamsError.new("You must specify the new_folder option to specify the destination folder") unless options.fetch(:new_folder, nil)
+        raise ClientParamsError.new("You must specify the new_filename option to specify the destination folder") unless options.fetch(:new_file_name, nil)
+
+        post "#{organization_name}/#{project_name}/#{path}/#{file_name}/move", options
+      end
+
+      def sync_check(organization_name, project_name, path, file_name, options={})
+        raise ClientParamsError.new("You must specify the md5 option of the file you are trying to sync check.") unless options.fetch(:md5, nil)
+        get "#{organization_name}/#{project_name}/#{path}/#{file_name}/sync_check", options
+      end
+    end
+  end
+end

data/lib/layervault/client/folders.rb

@@ -0,0 +1,27 @@
+module LayerVault
+  class Client
+    module Folders
+      def folder(organization_name, project_name, path)
+        get "#{organization_name}/#{project_name}/#{path}"
+      end
+
+      def delete_folder(organization_name, project_name, path)
+        delete "#{organization_name}/#{project_name}/#{path}"
+      end
+
+      def create_folder(organization_name, project_name, path)
+        post "#{organization_name}/#{project_name}/#{path}"
+      end
+
+      def move_folder(organization_name, project_name, path, options={})
+        raise ClientParamsError.new("You must specify the :to option for the destination folder.") unless options.fetch(:to, nil)
+        post "#{organization_name}/#{project_name}/#{path}/move", options
+      end
+
+      def change_folder_color(organization_name, project_name, path, options={})
+        raise ClientParamsError.new("You must specify the color option for the new color to apply to the folder.") unless options.fetch(:color, nil)
+        put "#{organization_name}/#{project_name}/#{path}", options
+      end
+    end
+  end
+end

data/lib/layervault/client/organizations.rb

@@ -0,0 +1,9 @@
+module LayerVault
+  class Client
+    module Organizations
+      def organization(name)
+        get "#{name}"
+      end
+    end
+  end
+end

data/lib/layervault/client/projects.rb

@@ -0,0 +1,25 @@
+module LayerVault
+  class Client
+    module Projects
+      def project(organization_name, project_name)
+        get "#{organization_name}/#{project_name}"
+      end
+
+      def create_project(organization_name, project_name)
+        post "#{organization_name}/#{project_name}"
+      end
+
+      def delete_project(organization_name, project_name)
+        delete "#{organization_name}/#{project_name}"
+      end
+
+      def move_project(organization_name, project_name, options={})
+        post "#{organization_name}/#{project_name}/move", options
+      end
+
+      def change_project_folder_color(organization_name, project_name, options={})
+        put "#{organization_name}/#{project_name}", options
+      end
+    end
+  end
+end