ruroku 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## Ruruku 0.0.2  (Jun 10, 2012)
+
+* Added collection reloading
+* Added collection caching
+* Added support of keys
+* Finding app by name
+* Added support of stacks
+
+## Ruroku 0.0.1 (Jun 9, 2012)
+
+* First public release (app, app addons, app collaborators, app config
+  vars, app domains, app processes, app releases, app stacks)

data/Gemfile

@@ -1,3 +1,12 @@
 source 'https://rubygems.org'
 
 gemspec
+
+platform :jruby do
+  gem 'jruby-openssl'
+end
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+end

data/README.md

@@ -1,7 +1,9 @@
 # Ruroku
+[![Build Status](https://secure.travis-ci.org/goshakkk/ruroku.png)](http://travis-ci.org/goshakkk/ruroku)
+[![Dependency Status](https://gemnasium.com/goshakkk/ruroku.png?travis)](https://gemnasium.com/goshakkk/ruroku)
 
-The Ruby client for Heroku API, built on top of official `heroku.rb`
-gem.
+The better Ruby client for Heroku API, built on top of official
+`heroku.rb` gem.
 
 ## Installation
 
@@ -21,7 +23,9 @@ Or install it yourself as:
 
 Start by initiating a connection with Heroku API:
 
-    heroku = Ruroku::API.new api_key: YOUR_HEROKU_API_KEY
+```ruby
+heroku = Ruroku::API.new api_key: YOUR_HEROKU_API_KEY
+```
 
 (You can leave out `:api_key` if `ENV['HEROKU_API_KEY']` is set
 instead.)
@@ -33,106 +37,234 @@ Now you can interact with Heroku API using Ruroku.
 Each API object has apps associated with the Heroku account. You can
 access an Array of all the associated apps with `#apps`:
 
-    heroku.apps
-    # => [#<App>, #<App>, #<App>]
-    
-    app = heroku.apps.first
+```ruby
+heroku.apps
+# => [#<App>, #<App>, #<App>]
 
-You then can get additional app info:
+app = heroku.apps.first
+```
 
-    app.id
-    app.name
-    app.stack
-    app.git_url
-    app.slug_size
-    app.repo_size
-    app.dynos
-    apps.workers
-    # and a few less interesting ones
+To get specific app:
+
+```ruby
+app = heroku.app 'app-name'
+```
+
+And access its properties such as:
+
+* `id`
+* `name`
+* `stack`
+* `git_url`
+* `slug_size`
+* `repo_size`
+* `dynos`
+* `workers`
 
 Maintenance mode can be turned on and off:
 
-    app.maintenance!
-    app.no_maintenance!
+```ruby
+app.maintenance!
+app.no_maintenance!
+```
 
-### Addons
+Also, imagine you've created another app after you you queried
+`heroku.app`. To refresh collection of apps (or other collections:
+addons, config vars, collaborators, and so on), just call `#reload` on
+collection:
 
-To get a list of addons used by a particular app:
+```ruby
+apps.reload
+```
 
-    addons = app.addons
-    # => [#<Addon>, #<Addon>, #<Addon>]
-    
-    addon = app.addons.first
+### Addons
 
-It's possible perform several actions on addon collections:
+To get a list of addons used by a particular app:
 
-#### Add an addon
+```ruby
+addons = app.addons
+# => [#<Addon>, #<Addon>, #<Addon>]
 
-    addons.add 'addon:plan'
+addon = app.addons.first
+```
 
-#### Remove an addon
+It's possible perform several actions on addon collections:
 
-    addons.delete 'addon-name'
+```ruby
+# Add an addon
+addons.add 'addon:plan'
 
-#### Upgrade an addon
+# Remove an addon
+addons.delete 'addon-name'
 
-    addons.upgrade 'addon:new-plan'
+# Upgrade an addon
+addons.upgrade 'addon:new-plan'
+```
 
 Each addon object is associated with the application. You can delete
 addons from the app by calling `#delete` method on the addon object as
 well:
 
-    addon.delete!
+```ruby
+addon.delete!
+```
 
 ### Collaborators
 
 List all app collaborators:
 
-    collaborators = app.collaborators
+```ruby
+collaborators = app.collaborators
+```
 
-#### Add a collaborator
+and
 
-    collaborators.add 'email@me.com'
+```ruby
+# Add a collaborator
+collaborators.add 'email@me.com'
 
-#### Remove a collaborator
+# Remove a collaborator
+collaborators.delete 'email@me.com'
+# or
+collaborator.delete!
+```
 
-    collaborators.delete 'email@me.com'
+### Config variables
 
-or
+List all app config vars:
 
-    collaborator.delete!
+```ruby
+config_vars = app.config_vars
+```
 
-### Config variables
+Add or delete a config var:
 
-List all app config vars:
+```ruby
+config_vars.add 'KEY' => 'value'
+config_vars.delete 'KEY'
+
+# or:
+
+config_var.delete!
+```
+
+They can also be updated like that:
 
-    app.config_vars
+```ruby
+config_var.value = 'new value'
+```
+
+And it'll instantly get updated.
 
 ### Domains
 
 Access domains used by the application:
 
-    app.domains
+```ruby
+domains = app.domains
+```
+
+Same as with other collection objects, they can be added or deleted:
+
+```ruby
+domains.add 'domain.com'
+domains.delete 'domain.com'
+
+# or:
+
+domain.delete!
+```
 
 ### Processes
 
 Get current application processes:
 
-    app.collaborators
+```ruby
+processes = app.processes
+```
+
+You can also run, restart, scale, and stop method collections:
+
+```ruby
+processes.run 'rake evolve'
+processes.restart
+processes.scale 'worker', 10
+processes.stop 'ps' => 'run.1'
+processes.stop 'type' => 'worker'
+```
 
 ### Releases
 
 List all app releases:
 
-    app.releases
+```ruby
+releases = app.releases
+```
+
+And rollback to any release:
+
+```ruby
+releases.rollback 'v1'
+```
+
+### Stacks
+
+List stacks, available for the app:
+
+```ruby
+app.stacks
+```
+
+Migrate the app to available stack:
+
+```ruby
+stacks.migrate 'stack-name'
+```
+
+### User
+
+Get User object associtaed with current heroku account:
+
+```ruby
+heroku.user
+```
+
+### Keys
+
+Access all keys:
+
+```ruby
+keys = heroku.keys
+```
+
+Add a key:
+
+```ruby
+keys.add 'content of id_rsa.pub here...'
+```
+
+Delete specific key:
+
+```ruby
+keys.delete 'email@me.com'
+key.delete!
+```
+
+Delete all keys:
+
+```ruby
+keys.delete_all
+```
 
 ## Mock
 
 For practice or testing you can also use a simulated Heroku:
 
-    require 'ruroku'
+```ruby
+require 'ruroku'
 
-    heroku = Ruroku::API.new api_key: API_KEY, mock: true
+heroku = Ruroku::API.new api_key: API_KEY, mock: true
+```
 
 After that commands should still behave the same, but they will only modify some local data instead of updating the state of things on Heroku.
 

data/Rakefile

@@ -1,2 +1,8 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task default: :spec
+
+RSpec::Core::RakeTask.new

data/TODO.md

@@ -1,6 +1,2 @@
 * Logs
-* Stacks
-* Keys
-* User info
 * Collection finder methods
-* Specs

data/lib/ruroku.rb

@@ -1,14 +1,17 @@
-require "heroku-api"
 require "time"
+require "heroku-api"
+require "virtus"
 require "active_support/core_ext/numeric"
 require "active_support/core_ext/string"
 
 require "ruroku/base"
 require "ruroku/nested_base"
 require "ruroku/resource_set"
+require "ruroku/nested_resource_set"
 
 require "ruroku/api"
 require "ruroku/app"
+require "ruroku/app_set"
 require "ruroku/addon"
 require "ruroku/addon_set"
 require "ruroku/collaborator"
@@ -21,6 +24,11 @@ require "ruroku/process"
 require "ruroku/process_set"
 require "ruroku/release"
 require "ruroku/release_set"
+require "ruroku/stack"
+require "ruroku/stack_set"
+require "ruroku/user"
+require "ruroku/key"
+require "ruroku/key_set"
 require "ruroku/version"
 
 module Ruroku

data/lib/ruroku/addon.rb

@@ -1,15 +1,13 @@
 module Ruroku
   class Addon < NestedBase
-    attr_accessor :name, :description, :url, :state, :price, :beta
-    deletable :name
+    attribute :name, String
+    attribute :description, String
+    attribute :url, String
+    attribute :state, String
+    attribute :price, Hash
+    attribute :beta, Boolean, default: false
 
-    # Public: Check if the addon is in beta.
-    def beta?
-      !!beta
-    end
-
-    def price=(value)
-      @price = value
-    end
+    resource_id :name
+    deletable_resource
   end
 end

data/lib/ruroku/addon_set.rb

@@ -1,5 +1,8 @@
 module Ruroku
-  class AddonSet < ResourceSet
+  class AddonSet < NestedResourceSet
+    resource_class Addon
+    collection_api_selector :get_addons
+
     # Map API methods to collection methods.
     #
     # Examples

data/lib/ruroku/api.rb

@@ -10,7 +10,26 @@ module Ruroku
     #
     # Returns the Array[App].
     def apps
-      heroku_api.get_apps.body.map { |app| App.new heroku_api, app }
+      @apps ||= AppSet.new heroku_api
+    end
+
+    # Public: Get specific app.
+    def app(app_name)
+      App.new heroku_api, heroku_api.get_app(app_name).body
+    end
+
+    # Public: Get keys associated with current heroku account.
+    def keys
+      @keys ||= KeySet.new heroku_api
+    end
+
+    # Public: Get User object associated with current heroku account.
+    def user
+      @user ||= User.new heroku_api, heroku_api.get_user.body
+    end
+
+    def inspect
+      "<#{self.class}>"
     end
   end
 end