dawn-api 0.10.1 → 0.11.0

data/lib/dawn/api/models/app.rb

@@ -6,49 +6,73 @@ require 'dawn/api/models/app/drains'
 require 'dawn/api/models/app/domains'
 require 'dawn/api/models/app/releases'
 
-module Dawn
-  class App
-
+module Dawn #:nodoc:
+  class App #:nodoc:
     include BaseApi
 
-    attr_reader :data
+    # @type [Dawn::App::Env]
     attr_reader :env
+    # @type [String]
+    data_key :id, write: false
+    # @type [Integer]
+    data_key :created_at, write: false
+    # @type [Integer]
+    data_key :updated_at, write: false
+    # @type [String]
+    data_key :name, write: false
+    # @type [Hash<String, Integer>]
+    data_key :formation
 
-    def initialize(hsh)
-      @data = hsh
-      @env = Env.new(self, @data.delete("env"))
+    ###
+    # @param [Hash] data
+    ###
+    def initialize(data)
+      @data = data
+      @data["env"] = @env = Env.new(self, @data.delete("env"))
     end
 
-    data_key :id
-    data_key :created_at
-    data_key :updated_at
-    data_key :name
-    data_key :formation
-    data_key :git
-
+    ###
+    # @return [Dawn::App::Gears]
+    ###
     def gears
       @gears ||= Gears.new self
     end
 
+    ###
+    # @return [Dawn::App::Drains]
+    ###
     def drains
       @drains ||= Drains.new self
     end
 
+    ###
+    # @return [Dawn::App::Domains]
+    ###
     def domains
       @domains ||= Domains.new self
     end
 
+    ###
+    # @return [Dawn::App::Releases]
+    ###
     def releases
       @releases ||= Releases.new self
     end
 
+    ###
+    # @return [self]
+    ###
     def refresh(options={})
       @data = get(
         path: "/apps/#{id}",
         query: options
       )["app"]
+      self
     end
 
+    ###
+    # @return [self]
+    ###
     def update(options={})
       options.fetch(:app)
 
@@ -56,34 +80,63 @@ module Dawn
         path: "/apps/#{id}",
         body: options.to_json
       )["app"]
+      self
     end
 
+    ###
+    # @return [self]
+    ###
+    def save
+      update(app: @data)
+    end
+
+    ###
+    # @param [Hash] options
+    ###
     def destroy(options={})
       self.class.destroy(options.merge(id: id))
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def run(options={})
       self.class.run(options.merge(id: id))
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def logs(options={})
       self.class.logs(options.merge(id: id))
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def scale(options={})
-      self.class.scale(options.merge(id: id))
+      @data["formation"] = self.class.scale(options.merge(id: id))
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def restart(options={})
       self.class.restart(options.merge(id: id))
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.id_param(options)
       options.delete(:id) ||
       options.delete(:name) ||
       raise
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.create(options)
       options.fetch(:app)
 
@@ -93,6 +146,10 @@ module Dawn
       )["app"]
     end
 
+    ###
+    # @param [Hash] options
+    # @return [Array<Dawn::App>]
+    ###
     def self.all(options={})
       get(
         path: "/apps",
@@ -100,6 +157,9 @@ module Dawn
       ).map { |d| new d["app"] }
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.find(options)
       id = id_param(options)
 
@@ -109,6 +169,9 @@ module Dawn
       )["app"]
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.update(options)
       id = id_param(options)
       options.fetch(:app)
@@ -119,6 +182,9 @@ module Dawn
       )["app"]
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.destroy(options={})
       id = id_param(options)
 
@@ -128,6 +194,9 @@ module Dawn
       )
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.restart(options={})
       id = id_param(options)
 
@@ -137,6 +206,9 @@ module Dawn
       )
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.logs(options={})
       id = id_param(options)
 
@@ -148,6 +220,9 @@ module Dawn
       "http://#{Dawn.log_host}#{url}"
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.scale(options={})
       id = id_param(options)
       options.fetch(:app).fetch(:formation)
@@ -158,6 +233,9 @@ module Dawn
       )
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.run(options={})
       id = id_param(options)
       options.fetch(:command)
@@ -167,6 +245,5 @@ module Dawn
         body: options.to_json
       )
     end
-
   end
 end

data/lib/dawn/api/models/domain.rb

@@ -1,39 +1,59 @@
 require 'dawn/api/base_api'
 
-module Dawn
-  class Domain
-
+module Dawn #:nodoc:
+  class Domain #:nodoc:
     include BaseApi
 
-    attr_reader :data
+    # @type [Dawn::App]
     attr_writer :app
+    # @type [String]
+    data_key :id, write: false
+    # @type [Integer]
+    data_key :created_at, write: false
+    # @type [Integer]
+    data_key :updated_at, write: false
+    # @type [String]
+    data_key :url, write: false
+    # @type [String]
+    data_key :app_id, path: "app/id", write: false
 
+    ###
+    # @param [Hash] data
+    ###
     def initialize(data)
       @app = nil
       @data = data
     end
 
-    data_key :id
-    data_key :created_at
-    data_key :updated_at
-    data_key :url
-    data_key :app_id, "app/id"
-
+    ###
+    # @return [Dawn::App]
+    ###
     def app
       @app ||= App.find(id: app_id)
     end
 
+    ###
+    # @return [self]
+    ###
     def refresh
       @data = get(
         path: "/domains/#{id}",
         query: options
       )["domain"]
+      self
     end
 
+    ###
+    # @param [Hash] options
+    # @return [Void]
+    ###
     def destroy(options={})
       self.class.destroy(options.merge(id: id))
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.id_param(options)
       id = options.delete(:id) ||
       options.delete(:name) ||
@@ -42,6 +62,9 @@ module Dawn
       raise
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.find(options)
       id = id_param(options)
 
@@ -51,6 +74,9 @@ module Dawn
       )["domain"]
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.destroy(options)
       id = id_param(options)
 
@@ -59,6 +85,5 @@ module Dawn
         query: options
       )
     end
-
   end
 end

data/lib/dawn/api/models/drain.rb

@@ -1,46 +1,58 @@
 require 'dawn/api/base_api'
 
-module Dawn
-  class Drain
-
+module Dawn #:nodoc:
+  class Drain #:nodoc:
     include BaseApi
 
-    attr_reader :data
+    # @type [Dawn::App]
     attr_writer :app
+    # @type [String]
+    data_key :id, write: false
+    # @type [Integer]
+    data_key :created_at, write: false
+    # @type [Integer]
+    data_key :updated_at, write: false
+    # @type [String]
+    data_key :url, write: false
+    # @type [String]
+    data_key :app_id, path: "app/id", write: false
 
+    ###
+    # @param [Hash] options
+    ###
     def initialize(data)
       @app = nil
       @data = data
     end
 
-    data_key :id
-    data_key :created_at
-    data_key :updated_at
-    data_key :url
-    data_key :app_id, "app/id"
-
+    ###
+    # @return [Dawn::App]
+    ###
     def app
       @app ||= App.find(id: app_id)
     end
 
+    ###
+    # @return [self]
+    ###
     def refresh
       @data = get(
         path: "/drains/#{id}",
         query: options
       )["drain"]
+      self
     end
 
-    def destroy(options)
+    ###
+    # @param [Hash] options
+    ###
+    def destroy(options={})
       Drain.destroy(options.merge(id: id))
     end
 
-    def self.all(options={})
-      get(
-        path: "/drains",
-        query: options
-      ).map { |hsh| new hsh["drain"] }
-    end
-
+    ###
+    # @param [Hash] options
+    ###
     def self.find(options={})
       id = id_param(options)
 
@@ -50,6 +62,9 @@ module Dawn
       )["drain"]
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.destroy(options={})
       id = id_param(options)
 
@@ -58,6 +73,5 @@ module Dawn
         query: options
       )
     end
-
   end
 end

data/lib/dawn/api/models/gear.rb

@@ -1,27 +1,39 @@
 require 'dawn/api/base_api'
 
-module Dawn
-  class Gear
-
+module Dawn #:nodoc:
+  class Gear #:nodoc:
     include BaseApi
 
-    attr_reader :data
+    # @type [Dawn::App]
     attr_writer :app
-
+    # @type [String]
+    data_key :id, write: false
+    # @type [Integer]
+    data_key :created_at, write: false
+    # @type [Integer]
+    data_key :updated_at, write: false
+    # @type [String]
+    data_key :name, write: false
+    # @type [Integer]
+    data_key :uptime, write: false
+    # @type [String]
+    data_key :proctype, write: false
+    # @type [Integer]
+    data_key :number, write: false
+    # @type [String]
+    data_key :app_id, path: "app/id", write: false
+
+    ###
+    # @param [Hash] data
+    ###
     def initialize(data)
       @app = nil
       @data = data
     end
 
-    data_key :id
-    data_key :created_at
-    data_key :updated_at
-    data_key :name
-    data_key :uptime
-    data_key :proctype
-    data_key :number
-    data_key :app_id, "app/id"
-
+    ###
+    # @return [Dawn::App]
+    ###
     def app
       @app ||= App.find(id: app_id)
     end
@@ -31,23 +43,26 @@ module Dawn
         path: "/gears/#{id}",
         query: options
       )["gear"]
+      self
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def restart(options={})
       self.class.restart(options.merge(id: id))
     end
 
-    def destroy(options)
+    ###
+    # @param [Hash] options
+    ###
+    def destroy(options={})
       self.class.destroy(options.merge(id: id))
     end
 
-    def self.all(options={})
-      get(
-        path: "/gears",
-        query: options
-      ).map { |d| new d["gear"] }
-    end
-
+    ###
+    # @param [Hash] options
+    ###
     def self.find(options)
       id = id_param(options)
 
@@ -57,8 +72,11 @@ module Dawn
       )["gear"]
     end
 
-    def self.restart(options={})
-      self.class.restart(options.merge(id: id))
+    ###
+    # @param [Hash] options
+    ###
+    def self.restart(options)
+      id = id_param(options)
 
       post(
         path: "/gears/#{id}/restart",
@@ -66,6 +84,9 @@ module Dawn
       )
     end
 
+    ###
+    # @param [Hash] options
+    ###
     def self.destroy(options)
       id = id_param(options)
 
@@ -74,6 +95,5 @@ module Dawn
         query: options
       )
     end
-
   end
 end

data/lib/dawn/api/models/key.rb

@@ -1,26 +1,38 @@
 require 'dawn/api/base_api'
 
-module Dawn
-  class Key
-
+module Dawn #:nodoc:
+  class Key #:nodoc:
     include BaseApi
 
-    attr_reader :data
+    # @type [String]
+    data_key :id, write: false
+    # @type [Integer]
+    data_key :created_at, write: false
+    # @type [Integer]
+    data_key :updated_at, write: false
+    # @type [String]
+    data_key :fingerprint, write: false
+    # @type [String]
+    data_key :key, write: false
 
+    ###
+    # @param [Hash] data
+    ###
     def initialize(data)
       @data = data
     end
 
-    data_key :id
-    data_key :created_at
-    data_key :updated_at
-    data_key :fingerprint
-    data_key :key
-
+    ###
+    # @return [Void]
+    ###
     def destroy(options={})
       self.class.destroy(options.merge(id: id))
     end
 
+    ###
+    # @param [Hash] options
+    # @return [Dawn::Key]
+    ###
     def self.create(options={})
       options.fetch(:key)
 
@@ -30,6 +42,10 @@ module Dawn
       )["key"]
     end
 
+    ###
+    # @param [Hash] options
+    # @return [Array<Dawn::Key>]
+    ###
     def self.all(options={})
       get(
         path: '/account/keys',
@@ -37,6 +53,10 @@ module Dawn
       ).map { |hsh| new hsh["key"] }
     end
 
+    ###
+    # @param [Hash] options
+    # @return [Dawn::Key]
+    ###
     def self.find(options={})
       id = id_param(options)
 
@@ -46,6 +66,9 @@ module Dawn
       )["key"]
     end
 
+    ###
+    # @return [Void]
+    ###
     def self.destroy(options={})
       id = id_param(options)
 
@@ -54,10 +77,5 @@ module Dawn
         query: options
       )
     end
-
-    class << self
-      private :new
-    end
-
   end
 end

data/lib/dawn/api/models/login.rb

@@ -1,16 +1,17 @@
 require 'dawn/api/base_api'
 
-module Dawn
-  class User
-
+module Dawn #:nodoc:
+  class User #:nodoc:
     include BaseApi
 
+    ###
+    # @param [Hash] options
+    ###
     def self.login(options={})
       post(
         path: '/login',
         body: options.to_json
       )
     end
-
   end
 end