dawn-api 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe30248ae573868bf991429cda95c8dfceec4bf7
-  data.tar.gz: 161aa1267f3bbc2d5e4a08b79db80157a411033f
+  metadata.gz: 7b1e546771ef62776a3f7def9a4de87059776ac6
+  data.tar.gz: 0f99cf21c60e819dcc1580698579fe35e0c0caea
 SHA512:
-  metadata.gz: bf6133ff0aa98e30f1d1f5b795b411e44aced402bcb524cdb836c01eb8978003b91f67c7038e1e4074761c1b2a1e673f2a5736d861c2b59ec80fb77b04c75309
-  data.tar.gz: 465a63b82801693130763868a26707871adbc88985e953c705d3bf9f54c0f9793cd488122b1c9d06bcc91913bf7215d45802ec47da26b75c6f4aef4852f0f4c3
+  metadata.gz: 8ab169c0ee2d465c74e50a566c4dfb4de03d1dd3825be826e9826fcb35615526e6bf7e756e0bcf7e0d55e8dba00cd7015bb5580d09d05e5a7f39c7e3a7f1dd28
+  data.tar.gz: f0127406fc40a51e23ac2b467b5e18372aba70bf479ace4f7c043d10272d387574bc1667fc3adf70aaf47823148ead06baf406ae0e079ce48ed055823120800c

data/README.md

@@ -1,12 +1,11 @@
 Dawn-API
 ========
-[link](https://github.com/dawn/dawn-api)
-
 [![Dependency Status](https://gemnasium.com/dawn/dawn-api.svg)](https://gemnasium.com/dawn/dawn-api)
 [![Gem Version](https://badge.fury.io/rb/dawn-api.svg)](http://badge.fury.io/rb/dawn-api)
 [![Code Climate](https://codeclimate.com/github/dawn/dawn-api.png)](https://codeclimate.com/github/dawn/dawn-api)
+[![Inch-CI](http://inch-ci.org/github/dawn/dawn-api.png?branch=master)](http://inch-ci.org/github/dawn/dawn-api)
 
-API for [Dawn](https://github.com/dawn/dawn)
+Ruby [API](https://github.com/dawn/dawn-api) for [Dawn](https://github.com/dawn/dawn)
 
 ## Installation
 ```shell
@@ -44,6 +43,6 @@ One day I'll write this properly, however for now:
 ```ruby
 Dawn.authenticate
 my_app = Dawn::App.create
-my_app.update(name: "DawnIsAwesome")
+my_app.domains.all
 my_app.gears.restart
 ```

data/lib/dawn/api/authenticate.rb

@@ -3,8 +3,10 @@ require 'base64'
 require 'excon'
 require 'netrc'
 
-module Dawn
-
+module Dawn #:nodoc:
+  ###
+  # Default request header
+  ###
   HEADERS = {
     'Accept'                => 'application/json',
     'Content-Type'          => 'application/json',
@@ -24,19 +26,44 @@ module Dawn
 
   class << self
     attr_accessor :last_response_body
+    attr_accessor :log
+  end
+
+  ###
+  # wrapper method for @log.puts
+  # This method will do nothing if log is nil or false
+  # @param [*] args
+  # @param [&] block
+  ###
+  def self.debug(*args, &block)
+    @log && @log.puts(*args, &block)
   end
 
+  ###
+  # @param [Hash] options
+  ###
   def self.request(options)
     Dawn.authenticate unless @connection
-    expects = options.delete(:expects)
     response = @connection.request(options)
     self.last_response_body = response.body
-    if expects && response.status != expects
-      raise Excon::Errors.status_error(options.merge(expects: expects), response)
-    end
     response
+  rescue Excon::Errors::HTTPStatusError => ex
+    self.last_response_body = ex.response.body
+    debug Time.now.strftime("%D %T")
+    debug options.inspect
+    debug ex.response.body
+    debug "\n"
+    raise ex
   end
 
+  ###
+  # @overload .authenticate
+  #   login using netrc
+  # @overload .authenticate(options)
+  #   Expects that options includes username and password keys, else defaults
+  #   to netrc login
+  # @param [Hash] options
+  ###
   def self.authenticate(options={})
     options = OPTIONS.merge(host: dawn_api_host, scheme: dawn_scheme).merge(options)
     options[:headers] = options[:headers].merge(HEADERS)
@@ -73,5 +100,4 @@ module Dawn
     )
     @connection = Excon.new "#{options[:scheme]}://#{options[:host]}", headers: @headers
   end
-
 end

data/lib/dawn/api/base_api.rb

@@ -1,9 +1,17 @@
 require 'dawn/api/authenticate'
+require 'dawn/api/safe/base_api'
 require 'json'
 
-module Dawn
-  module BaseApi
+module Dawn #:nodoc:
+  module BaseApi #:nodoc:
+    ###
+    # Base request extension module
+    ###
     module RequestExtension
+      ###
+      # Wrapper function around Dawn.request
+      # @param [Hash] options
+      ###
       def request(options)
         options[:expects] = 200 unless options.key?(:expects)
         JSON.load Dawn.request(options).body
@@ -14,31 +22,69 @@ module Dawn
       end
     end
 
-    module ClassExtension
+    module ClassExtension #:nodoc:
       include RequestExtension
 
+      ###
+      # Strips a valid id parameter from the given options.
+      # This method is normally overwritten in each subclass to suite their
+      # id needs.
+      # @param [Hash] options
+      # @return [String]
+      ###
       def id_param(options)
         options.delete(:id)
       end
 
-      def data_key(key_name, key_path=key_name)
+      ###
+      # @return [Array]
+      ###
+      def data_keys
+        @data_keys ||= []
+      end
+
+      ###
+      # Defines accessor for an internal @data Hash.
+      # Methods defined are (key_name) and (key_name)=
+      # @param [Symbol] key_name
+      # @param [Hash] options
+      ###
+      def data_key(key_name, options={})
+        options = { write: true, read: true, path: key_name }.merge(options)
+        key_path = options.fetch(:path)
+
         route = key_path.to_s.split("/")
         route_dp = route.dup
         last_key = route_dp.pop
 
         define_method(key_name) do
           route.inject(@data) { |d, key| d[key] }
-        end
+        end if options.fetch(:read)
         define_method(key_name.to_s+"=") do |v|
           route_dp.inject(@data) { |d, key| d[key] }[last_key] = v
-        end
+        end if options.fetch(:write)
+
+        data_keys.push(key_name)
+
+        return key_name
       end
     end
 
+    # :nodoc:
     def self.included(mod)
       mod.extend ClassExtension
     end
 
     include RequestExtension
+
+    ###
+    # Generates a Hash from the data_keys
+    # @return [Hash]
+    ###
+    def to_h
+      self.class.data_keys.each_with_object({}) do |key, hash|
+        hash[key] = send(key) if respond_to?(key)
+      end
+    end
   end
 end

data/lib/dawn/api/health_check.rb

@@ -0,0 +1,14 @@
+module Dawn #:nodoc:
+  module API #:nodoc:
+    ###
+    # Verifies that the server is running.
+    ###
+    def self.health_check
+      Dawn.request(
+        expects: 200,
+        method: :get,
+        path: "/healthcheck"
+      )
+    end
+  end
+end

data/lib/dawn/api/hosts.rb

@@ -1,23 +1,36 @@
-module Dawn
-
+module Dawn #:nodoc:
+  ###
+  # @return [String]
+  ###
   def self.dawn_scheme
     ENV["DAWN_SCHEME"] || "http"
   end
 
+  ###
+  # @return [String]
+  ###
   def self.dawn_host
     ENV["DAWN_HOST"] || "dawn.dev"
   end
 
+  ###
+  # @return [String]
+  ###
   def self.dawn_api_host
     ENV["DAWN_API_HOST"] || "api.#{dawn_host}"
   end
 
+  ###
+  # @return [String]
+  ###
   def self.git_host
     ENV["DAWN_GIT_HOST"] || dawn_host
   end
 
+  ###
+  # @return [String]
+  ###
   def self.log_host
     ENV["DAWN_LOG_HOST"] || "#{dawn_host}:8001"
   end
-
 end

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

@@ -1,43 +1,72 @@
 require 'dawn/api/base_api'
 
-module Dawn
-  class Account
-
+module Dawn #:nodoc:
+  class Account #:nodoc:
     include BaseApi
 
-    def initialize(hsh)
-      @data = hsh
-    end
-
-    data_key :id
-    data_key :created_at
-    data_key :updated_at
+    # @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 :username
+    # @type [String]
     data_key :email
-    data_key :api_key
+    # @type [String]
+    data_key :api_key, write: false
+
+    ###
+    # @param [Hash] data
+    ###
+    def initialize(data)
+      @data = data
+    end
 
+    ###
+    # @param [Hash] options
+    # @return [self]
+    ###
     def refresh(options={})
       @data = get(
         path: "/account",
         query: options
-      )["account"]
+      )["user"]
+      self
     end
 
+    ###
+    # @param [Hash] options
+    # @return [self]
+    ###
     def update(options={})
       options.fetch(:account)
 
       @data = patch(
         path: "/account",
         body: options.to_json
-      )["account"]
+      )["user"]
+      self
+    end
+
+    ###
+    # Using the currently stored @data, #update self
+    # @return [self]
+    ###
+    def save
+      update(account: @data)
     end
 
+    ###
+    # @param [Hash] data
+    # @return [Dawn::Account]
+    ###
     def self.current(options={})
       new get(
         path: "/account",
         query: options
-      )["account"]
+      )["user"]
     end
-
   end
 end

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

@@ -1,23 +1,38 @@
 require 'dawn/api/base_api'
 require 'dawn/api/models/domain'
 
-module Dawn
-  class App
-    class Domains
-
-      include BaseApi
-      include Enumerable
+module Dawn #:nodoc:
+  class App #:nodoc:
+    class Domains #:nodoc:
+      include BaseApi, Enumerable
 
+      # @type [Dawn::App]
       attr_reader :app
 
+      ###
+      # @param [Dawn::App] app
+      ###
       def initialize(app)
         @app = app
       end
 
+      ###
+      # @return [Array<Dawn::Domain>]
+      ###
+      def to_a
+        all
+      end
+
+      ###
+      # @overload each { |domain| do_stuff_with_domain }
+      ###
       def each(&block)
         all.each(&block)
       end
 
+      ###
+      # @return [Dawn::Domain]
+      ###
       def create(options)
         options.fetch(:domain)
 
@@ -27,6 +42,9 @@ module Dawn
         )["domain"]).tap { |d| d.app = @app }
       end
 
+      ###
+      # @return [Array<Dawn::Domain>]
+      ###
       def all(options={})
         get(
           path: "/apps/#{app.id}/domains",
@@ -34,10 +52,16 @@ module Dawn
         ).map { |hsh| Domain.new(hsh["domain"]).tap { |d| d.app = @app } }
       end
 
+      ###
+      # @return [Dawn::Domain]
+      ###
       def find(options)
         Domain.find(options).tap { |d| d.app = @app }
       end
 
+      def destroy(options)
+        Domain.destroy(options)
+      end
     end
   end
 end

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

@@ -1,23 +1,38 @@
 require 'dawn/api/base_api'
 require 'dawn/api/models/drain'
 
-module Dawn
-  class App
-    class Drains
-
-      include BaseApi
-      include Enumerable
+module Dawn #:nodoc:
+  class App #:nodoc:
+    class Drains #:nodoc:
+      include BaseApi, Enumerable
 
+      # @type [Dawn::App]
       attr_reader :app
 
+      ###
+      # @param [Dawn::App] app
+      ###
       def initialize(app)
         @app = app
       end
 
+      ###
+      # @return [Array<Dawn::Drain>]
+      ###
+      def to_a
+        all
+      end
+
+      ###
+      # @overload each { |drain| do_stuff_with_drain }
+      ###
       def each(&block)
         all.each(&block)
       end
 
+      ###
+      # @return [Dawn::Drain]
+      ###
       def create(options={})
         options.fetch(:drain)
 
@@ -27,6 +42,9 @@ module Dawn
         )["drain"]).tap { |d| d.app = @app }
       end
 
+      ###
+      # @return [Array<Dawn::Drain>]
+      ###
       def all(options={})
         get(
           path: "/apps/#{app.id}/drains",
@@ -34,10 +52,16 @@ module Dawn
         ).map { |hsh| Drain.new(hsh["drain"]).tap { |d| d.app = @app } }
       end
 
+      ###
+      # @return [Dawn::Drain]
+      ###
       def find(options={})
         Drain.find(options).tap { |d| d.app = @app }
       end
 
+      def destroy(options)
+        Drain.destroy(options)
+      end
     end
   end
 end

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

@@ -1,19 +1,31 @@
 require 'dawn/api/base_api'
 
-module Dawn
-  class App
-    class Env < Hash
-
+module Dawn #:nodoc:
+  class App #:nodoc:
+    class Env < Hash #:nodoc:
+      # horrible hack to restore Hash#delete
+      alias :__delete__ :delete
       include BaseApi
+      alias :api_delete :delete
+      alias :delete :__delete__
+      remove_method :__delete__
 
+      # @type [Dawn::App]
       attr_reader :app
 
+      ###
+      # @param [Dawn::App] app
+      # @param [Hash] data
+      ###
       def initialize(app, data)
         @app = app
         super()
         replace(data)
       end
 
+      ###
+      # @param [Hash] options
+      ###
       def refresh(options={})
         replace get(
           path: "/apps/#{app.id}/env",
@@ -21,13 +33,15 @@ module Dawn
         )["env"]
       end
 
+      ###
+      # @param [Hash] options
+      ###
       def save(options={})
         replace post(
           path: "/apps/#{app.id}/env",
           body: { app: { env: merge(options) } }.to_json
         )["env"]
       end
-
     end
   end
 end

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

@@ -1,25 +1,40 @@
 require 'dawn/api/base_api'
 require 'dawn/api/models/gear'
 
-module Dawn
-  class App
-    class Gears
-
-      include BaseApi
-      include Enumerable
+module Dawn #:nodoc:
+  class App #:nodoc:
+    class Gears #:nodoc:
+      include BaseApi, Enumerable
 
+      # @type [Dawn::App]
       attr_reader :app
 
+      ###
+      # @param [Dawn::App] app
+      ###
       def initialize(app)
         @app = app
       end
 
+      ###
+      # @return [Array<Dawn::Gear>]
+      ###
+      def to_a
+        all
+      end
+
+      ###
+      # @overload each { |gear| do_stuff_with_gear }
+      ###
       def each(&block)
         all.each(&block)
       end
 
+      ###
+      # @return [Dawn::Gear]
+      ###
       def create(options={})
-        options.fetch(:gear)
+        #options.fetch(:gear)
 
         Gear.new(post(
           path: "/apps/#{app.id}/gears",
@@ -27,6 +42,9 @@ module Dawn
         )["gear"]).tap { |d| d.app = @app }
       end
 
+      ###
+      # @return [Array<Dawn::Gear>]
+      ###
       def all(options={})
         get(
           path: "/apps/#{app.id}/gears",
@@ -34,6 +52,9 @@ module Dawn
         ).map { |hsh| Gear.new(hsh["gear"]).tap { |d| d.app = @app } }
       end
 
+      ###
+      # @return [Dawn::Gear]
+      ###
       def find(options={})
         Gear.find(options).tap { |d| d.app = @app }
       end
@@ -45,6 +66,9 @@ module Dawn
         )
       end
 
+      def destroy(options)
+        Gear.destroy(options)
+      end
     end
   end
 end

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

@@ -1,25 +1,40 @@
 require 'dawn/api/base_api'
 require 'dawn/api/models/release'
 
-module Dawn
-  class App
-    class Releases
-
-      include BaseApi
-      include Enumerable
+module Dawn #:nodoc:
+  class App #:nodoc:
+    class Releases #:nodoc:
+      include BaseApi, Enumerable
 
+      # @type [Dawn::App]
       attr_reader :app
 
+      ###
+      # @param [Dawn::App] app
+      ###
       def initialize(app)
         @app = app
       end
 
+      ###
+      # @return [Array<Dawn::Release>]
+      ###
+      def to_a
+        all
+      end
+
+      ###
+      # @overload each { |release| do_stuff_with_release }
+      ###
       def each(&block)
         all.each(&block)
       end
 
+      ###
+      # @return [Dawn::Release]
+      ###
       def create(options={})
-        options.fetch(:release)
+        #options.fetch(:release)
 
         Release.new(post(
           path: "/apps/#{app.id}/releases",
@@ -27,6 +42,9 @@ module Dawn
         )["release"]).tap { |d| d.app = @app }
       end
 
+      ###
+      # @return [Array<Dawn::Release>]
+      ###
       def all(options={})
         get(
           path: "/apps/#{app.id}/releases",
@@ -34,10 +52,12 @@ module Dawn
         ).map { |hsh| Release.new(hsh["release"]).tap { |d| d.app = @app } }
       end
 
+      ###
+      # @return [Dawn::Release]
+      ###
       def find(options={})
         Release.find(options).tap { |d| d.app = @app }
       end
-
     end
   end
 end