aptible-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de97a55e4f0426413608ac2336bb10152a27d585
+  data.tar.gz: dae4ae1d019a5c468cb424d26329b19f5108cd10
+SHA512:
+  metadata.gz: 7edc220e803b9befb996aa0ded1c1edd956f0921ac2e9fbe613ed8976073a84ae47f8c96feddd4527d34bde4a7e48e89186fb1301264e6adf953faac4b082e59
+  data.tar.gz: 26f4455b8a8e03aedc70913dad6ae69c848530216103918cc8c768e7680253b443e3b497630def96ff39193239313c0492b6d15894fe055db479ee57faf48934

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 2.0.0
+  - jruby

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'oauth2', github: 'fancyremarker/oauth2', branch: 'aptible'
+gem 'hyperresource', github: 'fancyremarker/hyperresource', branch: 'aptible'
+
+# Specify your gem's dependencies in aptible-api.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Aptible, Inc.
+
+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,70 @@
+# ![](https://raw.github.com/aptible/straptible/master/lib/straptible/rails/templates/public.api/icon-60px.png) Aptible::Api
+
+[![Gem Version](https://badge.fury.io/rb/aptible-api.png)](https://rubygems.org/gems/aptible-api)
+[![Build Status](https://travis-ci.org/aptible/aptible-api-ruby.png?branch=master)](https://travis-ci.org/aptible/aptible-api-ruby)
+[![Dependency Status](https://gemnasium.com/aptible/aptible-api-ruby.png)](https://gemnasium.com/aptible/aptible-api-ruby)
+
+Ruby client for [api.aptible.com](https://api.aptible.com/). Aptible's API server is built on top of [HAL+JSON](http://tools.ietf.org/html/draft-kelly-json-hal-06), and so this client is just a thin layer on top of the [HyperResource](https://github.com/gamache/hyperresource) gem.
+
+## Installation
+
+Add the following lines to your application's Gemfile.
+
+    gem 'aptible-api'
+    gem 'hyperresource', github: 'fancyremarker/hyperresource', branch: 'aptible'
+
+The forked version of the HyperResource gem is necessary until [gamache/hyperresource#19](https://github.com/gamache/hyperresource/pull/19) is merged.
+
+And then run `bundle install`.
+
+## Usage
+
+First, get a token:
+
+```ruby
+token = Aptible::Auth::Token.new(email: 'user0@example.com', password: 'password')
+```
+
+Then, initialize a client:
+```ruby
+api = Aptible::Api::Client.new(token: token)
+```
+
+From here, you can interact with the Authorization API however you wish:
+
+```ruby
+api.get.clients.count
+# => 4
+api.get.clients.first.name
+# => "Client 0"
+client = api.get.clients.create(name: 'Dogeclient')
+client.href
+# => "http://localhost:4000/clients/60765b69-ffd8-4762-b9d2-96354ddb16f9"
+```
+
+## Configuration
+
+| Parameter | Description | Default |
+| --------- | ----------- | --------------- |
+| `root_url` | Root URL of the authorization server | `https://api.aptible.com` |
+
+To point the client at a different authorization server (e.g., during development), add the following to your application's initializers:
+
+```ruby
+Aptible::Api.configure do |config|
+  config.root_url = 'http://some.other.url'
+end
+```
+
+## Contributing
+
+1. Fork the project.
+1. Commit your changes, with specs.
+1. Ensure that your code passes specs (`rake spec`) and meets Aptible's Ruby style guide (`rake rubocop`).
+1. Create a new pull request on GitHub.
+
+## Copyright and License
+
+MIT License, see [LICENSE](LICENSE.md) for details.
+
+Copyright (c) 2013 [Aptible](https://www.aptible.com), Frank Macreery, and contributors.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+
+require 'aptible/tasks'
+Aptible::Tasks.load_tasks

data/aptible-api.gemspec

@@ -0,0 +1,31 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'English'
+require 'aptible/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aptible-api'
+  spec.version       = Aptible::Api::VERSION
+  spec.authors       = ['Frank Macreery']
+  spec.email         = ['frank@macreery.com']
+  spec.description   = %q{Ruby client for api.aptible.com}
+  spec.summary       = %q{Ruby client for api.aptible.com}
+  spec.homepage      = 'https://github.com/aptible/aptible-api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'gem_config'
+  spec.add_dependency 'hyperresource'
+  spec.add_dependency 'aptible-auth'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'aptible-tasks', '>= 0.2.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.0'
+  spec.add_development_dependency 'pry'
+end

data/lib/aptible/api.rb

@@ -0,0 +1,14 @@
+require 'aptible/api/version'
+require 'aptible/api/client'
+
+require 'gem_config'
+
+module Aptible
+  module Api
+    include GemConfig::Base
+
+    with_configuration do
+      has :root_url, classes: [String], default: 'https://api.aptible.com'
+    end
+  end
+end

data/lib/aptible/api/client.rb

@@ -0,0 +1,37 @@
+require 'hyperresource'
+
+module Aptible
+  module Api
+    class Client < HyperResource
+      attr_accessor :token, :config
+
+      def initialize(options = {})
+        unless options.is_a?(Hash)
+          fail ArgumentError, 'Call Aptible::Api::Client.new with a Hash'
+        end
+        self.token = options[:token]
+
+        options[:root] ||= config.root_url
+        options[:headers] ||= { 'Content-Type' => 'application/json' }
+        options[:headers].merge!(
+          'Authorization' => "Bearer #{bearer_token}"
+        ) if options[:token]
+
+        super(options)
+      end
+
+      def bearer_token
+        # REVIEW: Should we really allow any token type here?
+        case token
+        when Aptible::Auth::Token then token.access_token
+        when Fridge::AccessToken then token.to_s
+        when String then token
+        end
+      end
+
+      def config
+        @config ||= Aptible::Api.configuration
+      end
+    end
+  end
+end

data/lib/aptible/api/version.rb

@@ -0,0 +1,5 @@
+module Aptible
+  module Api
+    VERSION = '0.1.0'
+  end
+end

data/spec/aptible/api/client_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Aptible::Api::Client do
+  describe '#initialize' do
+    it 'should be a HyperResource instance' do
+      expect(subject).to be_a HyperResource
+    end
+  end
+end

data/spec/aptible/api_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Aptible::Api do
+  it 'should have a configurable root_url' do
+    config = described_class.configuration
+    expect(config).to be_a GemConfig::Configuration
+    expect(config.root_url).to eq 'https://api.aptible.com'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+# Load shared spec files
+Dir["#{File.dirname(__FILE__)}/shared/**/*.rb"].each do |file|
+  require file
+end
+
+# Require library up front
+require 'aptible/api'

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: aptible-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frank Macreery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hyperresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aptible-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: aptible-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Ruby client for api.aptible.com
+email:
+- frank@macreery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- aptible-api.gemspec
+- lib/aptible/api.rb
+- lib/aptible/api/client.rb
+- lib/aptible/api/version.rb
+- spec/aptible/api/client_spec.rb
+- spec/aptible/api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aptible/aptible-api
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for api.aptible.com
+test_files:
+- spec/aptible/api/client_spec.rb
+- spec/aptible/api_spec.rb
+- spec/spec_helper.rb