dawn-api 0.10.1 → 0.11.0

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

@@ -1,37 +1,52 @@
 require 'dawn/api/base_api'
 
-module Dawn
-  class Release
-
+module Dawn #:nodoc:
+  class Release #: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 :image, 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 :image
-    data_key :app_id, "app/id"
-
+    ###
+    # @return [Dawn::App]
+    ###
     def app
       @app ||= App.find(id: app_id)
     end
 
+    ###
+    # @return [self]
+    ###
     def refresh
-      @data = request(
-        expects: 200,
-        method: :get,
+      @data = get(
         path: "/releases/#{id}",
         query: options
       )["release"]
+      self
     end
 
+    ###
+    # @param [Hash] options
+    # @return [Array<Dawn::Release>]
+    ###
     def self.all(options={})
       get(
         path: "/releases",
@@ -39,6 +54,10 @@ module Dawn
       ).map { |hsh| new hsh["release"] }
     end
 
+    ###
+    # @param [Hash] options
+    # @return [Dawn::Release]
+    ###
     def self.find(options={})
       id = id_param(options)
 
@@ -47,6 +66,5 @@ module Dawn
         query: options
       )["release"]
     end
-
   end
 end

data/lib/dawn/api/safe/base_api.rb

@@ -1,8 +1,8 @@
 require "dawn/api/safe/safe_extension"
 
-module Dawn
-  module BaseApi
-    module RequestExtension
+module Dawn #:nodoc:
+  module BaseApi #:nodoc:
+    module RequestExtension #:nodoc:
       include Dawn::SafeExtension
     end
   end

data/lib/dawn/api/safe/safe_extension.rb

@@ -1,19 +1,25 @@
-module Dawn
-  module SafeExtension
-    class SafeContext
+module Dawn #:nodoc:
+  module SafeExtension #:nodoc:
+    class SafeContext #:nodoc:
+      # @type [Exception]
       attr_accessor :last_exception
 
+      ###
+      # @param [Object] obj
+      ###
       def initialize(obj)
         @obj = obj
         @last_exception = nil
       end
 
+      # :nodoc:
       def method_missing(sym, *args, &block)
         if @obj.respond_to?(sym)
           begin
             @obj.send sym, *args, &block
           rescue => ex
             self.last_exception = ex
+            false
           end
         else
           @obj.method_missing sym, *args, &block
@@ -21,8 +27,17 @@ module Dawn
       end
     end
 
-    def safe
-      SafeContext.new(self)
+    ###
+    # @overload safe
+    #   Creates a new SafeContext for the object
+    #   @return [SafeContext]
+    # @overload safe(symbol, *args, &block)
+    #   @return [Object]  result from method invocation
+    ###
+    def safe(*args, &block)
+      context = SafeContext.new(self)
+      return context.send(*args, &block) unless args.empty?
+      context
     end
   end
 end

data/lib/dawn/api/version.rb

@@ -1,9 +1,9 @@
-module Dawn
-  module API
-    module Version
+module Dawn #:nodoc:
+  module API #:nodoc:
+    module Version #:nodoc:
       MAJOR = 0
-      MINOR = 10
-      PATCH = 1
+      MINOR = 11
+      PATCH = 0
       BUILD = nil
       STRING = [[MAJOR, MINOR, PATCH].compact.join("."), BUILD].compact.join("-").freeze
     end

data/lib/dawn/api.rb

@@ -3,4 +3,4 @@ require 'json'
 require 'dawn/api/version'
 require 'dawn/api/authenticate'
 require 'dawn/api/models'
-
+require 'dawn/api/health_check'

data/spec/api/account_spec.rb

@@ -0,0 +1,21 @@
+require 'api_spec_helper'
+
+describe Dawn::Account, :vcr do
+  subject { Dawn::Account }
+
+  it { should be_a Class }
+
+  describe ".current" do
+    it "should retrieve current user account" do
+      Dawn::Account.current
+    end
+  end
+
+  describe "#update" do
+    subject { Dawn::Account.current }
+
+    it "should update an account" do
+      subject.update(account: { username: "MyNameIs" })
+    end
+  end
+end

data/spec/api/app/domains_spec.rb

@@ -0,0 +1,30 @@
+require 'api_spec_helper'
+
+describe Dawn::App::Domains, :vcr do
+  subject { Dawn::App::Domains }
+
+  let(:app) { Dawn::App.find(name: "domains-test") }
+
+  it { should be_a Class }
+
+  ###
+  context "#all" do
+    subject { app.domains }
+
+    it "should return all domains" do
+      subject.all
+    end
+
+    it "should have only domains" do
+      subject.all.all? { |domain| expect(domain).to be_an_instance_of(Dawn::Domain) }
+    end
+  end
+
+  context "#create" do
+    subject { app.domains }
+
+    it "should create a new domain" do
+      subject.create(domain: { url: "http://wearepeople.io" })
+    end
+  end
+end

data/spec/api/app/drains_spec.rb

@@ -0,0 +1,30 @@
+require 'api_spec_helper'
+
+describe Dawn::App::Drains, :vcr do
+  subject { Dawn::App::Drains }
+
+  let(:app) { Dawn::App.find(name: "drains-test") }
+
+  it { should be_a Class }
+
+  ###
+  context "#all" do
+    subject { app.drains }
+
+    it "should return all drains" do
+      subject.all
+    end
+
+    it "should have only drains" do
+      subject.all.all? { |drain| expect(drain).to be_an_instance_of(Dawn::Drain) }
+    end
+  end
+
+  context "#create" do
+    subject { app.drains }
+
+    it "should create a new drain" do
+      subject.create(drain: { url: "http://flush.it" })
+    end
+  end
+end

data/spec/api/app/gears_spec.rb

@@ -0,0 +1,38 @@
+require 'api_spec_helper'
+
+describe Dawn::App::Gears, :vcr do
+  subject { Dawn::App::Gears }
+
+  let(:app) { Dawn::App.find(name: "gears-test") }
+
+  it { should be_a Class }
+
+  ###
+  context "#all" do
+    subject { app.gears }
+
+    it "should return all gears" do
+      subject.all
+    end
+
+    it "should have only gears" do
+      subject.all.all? { |gear| expect(gear).to be_an_instance_of(Dawn::Gear) }
+    end
+  end
+
+  context "#restart" do
+    subject { app.gears }
+
+    it "should restart all gears" do
+      subject.restart
+    end
+  end
+
+  context "#create" do
+    subject { app.gears }
+
+    it "should create a new gear" do
+      subject.create
+    end
+  end
+end

data/spec/api/app/releases_spec.rb

@@ -0,0 +1,30 @@
+require 'api_spec_helper'
+
+describe Dawn::App::Releases, :vcr do
+  subject { Dawn::App::Releases }
+
+  let(:app) { Dawn::App.find(name: "releases-test") }
+
+  it { should be_a Class }
+
+  ###
+  context "#all" do
+    subject { app.releases }
+
+    it "should return all releases" do
+      subject.all
+    end
+
+    it "should have only releases" do
+      subject.all.all? { |release| expect(release).to be_an_instance_of(Dawn::Release) }
+    end
+  end
+
+  context "#create" do
+    subject { app.releases }
+
+    it "should create a new release" do
+      subject.create
+    end
+  end
+end

data/spec/api/app_spec.rb

@@ -0,0 +1,166 @@
+require 'api_spec_helper'
+
+describe Dawn::App, :vcr do
+  subject { Dawn::App }
+
+  let(:app_name1) { "cookie-crushers" }
+  let(:app_name2) { "cookie-crushers2" }
+  let(:app_name3) { "some-app" }
+  let(:app_name4) { "some-app-thing" }
+  let(:invalid_app_name) { "ThaTunaCorps" }
+
+  let(:app) { Dawn::App.find(name: app_name1) }
+
+  it { should be_a Class }
+
+  describe ".all" do
+    it "should retrieve all user apps" do
+      subject.all
+    end
+
+    it "should only have an array of apps" do
+      subject.all.all? { |o| expect(o).to be_an_instance_of(Dawn::App) }
+    end
+  end
+
+  describe ".create" do
+    it "should raise an IndexError if app key is missing" do
+      expect { subject.create(blurp: { name: app_name1 }) }.to raise_error(IndexError)
+    end
+
+    it "should create a new app, given a name" do
+      subject.create(app: { name: app_name1 })
+    end
+
+    it "should raise an Excon::Errors::UnprocessableEntity when an invalid name is given" do
+      expect { subject.create(app: { name: invalid_app_name }) }.to raise_error(Excon::Errors::UnprocessableEntity)
+    end
+  end
+
+  describe ".find" do
+    it "should retrieve 1 app by id" do
+      app = subject.all.first
+      subject.find(id: app.id)
+    end
+
+    it "should retrieve 1 app by name" do
+      subject.find(name: app_name1)
+    end
+
+    it "should fail to find a non existant app" do
+      expect { subject.find(id: -1) }.to raise_error(Excon::Errors::NotFound)
+    end
+  end
+
+  describe ".update" do
+    it "should raise an IndexError if app key is missing" do
+      expect { subject.update(name: app_name1, blurp: { name: app_name2 }) }.to raise_error(IndexError)
+    end
+
+    it "should fail to update non-existant app" do
+      expect { subject.update(name: app_name3, app: { name: app_name4 }) }.to raise_error(Excon::Errors::NotFound)
+    end
+  end
+
+  describe ".destroy" do
+    it "should fail to destroy non-existant app" do
+      expect { subject.destroy(name: app_name3) }.to raise_error(Excon::Errors::NotFound)
+    end
+  end
+
+  describe ".restart" do
+    it "should fail to restart a non existant app" do
+      expect { subject.restart(id: -1) }.to raise_error(Excon::Errors::NotFound)
+    end
+  end
+
+  describe ".logs" do
+    it "should fail to retrieve logs uri for a non existant app" do
+      expect { subject.logs(id: -1) }.to raise_error(Excon::Errors::NotFound)
+    end
+  end
+
+  describe "#restart" do
+    it "should restart the the app" do
+      app.restart
+    end
+  end
+
+  describe "#logs" do
+    it "should retrieve logs url for app" do
+      app.logs
+    end
+  end
+
+  describe "#scale" do
+    it "should raise an IndexError if app key is missing" do
+      expect { app.scale blurp: { formation: { web: 2 } } }.to raise_error(IndexError)
+    end
+
+    it "should scale app" do
+      app.scale app: { formation: { web: 2 } }
+    end
+
+    it "should have updated formation" do
+      app.formation["web"].should eq("2")
+    end
+  end
+
+  describe "#gears" do
+    it "should have gears" do
+      expect(app.gears).to be_an_instance_of(Dawn::App::Gears)
+    end
+
+    it "should retrieve gears" do
+      app.gears.all
+    end
+
+    it "should restart gears" do
+      app.gears.restart
+    end
+  end
+
+  describe "#drains" do
+    it "should have drains" do
+      expect(app.drains).to be_an_instance_of(Dawn::App::Drains)
+    end
+
+    it "should retrieve drains" do
+      app.drains.all
+    end
+  end
+
+  describe "#domains" do
+    it "should have domains" do
+      expect(app.domains).to be_an_instance_of(Dawn::App::Domains)
+    end
+
+    it "should retrieve domains" do
+      app.domains.all
+    end
+  end
+
+  describe "#releases" do
+    it "should have releases" do
+      expect(app.releases).to be_an_instance_of(Dawn::App::Releases)
+    end
+
+    it "should retrieve releases" do
+      app.releases.all
+    end
+  end
+
+  describe "#update" do
+    it "should update 1 app" do
+      app = subject.find(name: "cookie-crushers")
+      app.update(app: { name: "bread-crushers" })
+    end
+  end
+
+  describe "#destroy" do
+    it "should destroy 1 app" do
+      app = subject.find(name: "bread-crushers")
+      app.destroy(name: "bread-crushers")
+    end
+  end
+end

data/spec/api/domain_spec.rb

@@ -0,0 +1,54 @@
+require 'api_spec_helper'
+
+describe Dawn::Domain, :vcr do
+  subject { Dawn::Domain }
+
+  before :all do
+    $test_store.test_domain_app ||= Dawn::App.find(id: $test_store.ref["apps"]["domain-test"])
+    $test_store.test_domain1 ||= Dawn::Domain.find(id: $test_store.ref["domains"]["cc-rushers.io"])
+    $test_store.test_domain2 ||= Dawn::Domain.find(id: $test_store.ref["domains"]["cookiecrushers.com"])
+    $test_store.test_domain3 ||= Dawn::Domain.find(id: $test_store.ref["domains"]["cookie-crusher.net"])
+  end
+
+  after :all do
+    $test_store.delete_field(:test_domain1) rescue nil
+    $test_store.delete_field(:test_domain2) rescue nil
+    $test_store.delete_field(:test_domain3) rescue nil
+  end
+
+  it { should be_a Class }
+
+  describe ".find" do
+    it "should raise an Excon::Errors::NotFound when Domain cannot be found" do
+      expect { subject.find(id: -1) }.to raise_error(Excon::Errors::NotFound)
+    end
+
+    it "should find 1 domain by id" do
+      subject.find(id: $test_store.test_domain1.id)
+    end
+
+    it "should find 1 domain by url" do
+      subject.find(url: $test_store.test_domain2.url)
+    end
+  end
+
+  describe ".destroy" do
+    it "should raise an Excon::Errors::NotFound when Domain cannot be found" do
+      expect { subject.destroy(id: -1) }.to raise_error(Excon::Errors::NotFound)
+    end
+
+    it "should destroy 1 domain by id" do
+      subject.destroy(id: $test_store.test_domain1.id)
+    end
+
+    it "should destroy 1 domain by url" do
+      subject.destroy(url: $test_store.test_domain2.url)
+    end
+  end
+
+  describe "#destroy" do
+    it "should destroy the domain" do
+      $test_store.test_domain3.destroy
+    end
+  end
+end

data/spec/api/drain_spec.rb

@@ -0,0 +1,54 @@
+require 'api_spec_helper'
+
+describe Dawn::Drain, :vcr do
+  subject { Dawn::Drain }
+
+  before :all do
+    $test_store.test_drain_app ||= Dawn::App.find(id: $test_store.ref["apps"]["drain-test"])
+    $test_store.test_drain1 ||= Dawn::Drain.find(id: $test_store.ref["drains"]["flushme.io"])
+    $test_store.test_drain2 ||= Dawn::Drain.find(id: $test_store.ref["drains"]["toil.com"])
+    $test_store.test_drain3 ||= Dawn::Drain.find(id: $test_store.ref["drains"]["downthedrain.net"])
+  end
+
+  after :all do
+    $test_store.delete_field(:test_drain1) rescue nil
+    $test_store.delete_field(:test_drain2) rescue nil
+    $test_store.delete_field(:test_drain3) rescue nil
+  end
+
+  it { should be_a Class }
+
+  describe ".find" do
+    it "should raise an Excon::Errors::NotFound when Drain cannot be found" do
+      expect { subject.find(id: -1) }.to raise_error(Excon::Errors::NotFound)
+    end
+
+    it "should find 1 drain by id" do
+      subject.find id: $test_store.test_drain1.id
+    end
+
+    it "should find 1 drain by url" do
+      subject.find url: $test_store.test_drain2.url
+    end
+  end
+
+  describe ".destroy" do
+    it "should raise an Excon::Errors::NotFound when Drain cannot be found" do
+      expect { subject.destroy(id: -1) }.to raise_error(Excon::Errors::NotFound)
+    end
+
+    it "should destroy 1 drain by id" do
+      subject.destroy(id: $test_store.test_drain1.id)
+    end
+
+    it "should destroy 1 drain by url" do
+      subject.destroy(url: $test_store.test_drain2.url)
+    end
+  end
+
+  describe "#destroy" do
+    it "should destroy the drain" do
+      $test_store.test_drain3.destroy
+    end
+  end
+end

data/spec/api/gear_spec.rb

@@ -0,0 +1,65 @@
+require 'api_spec_helper'
+
+describe Dawn::Gear, :vcr do
+  subject { Dawn::Gear }
+
+  before :all do
+    $test_store.test_gear_app ||= Dawn::App.find(id: $test_store.ref["apps"]["gear-test"])
+    $test_store.test_gear1 ||= Dawn::Gear.find(id: $test_store.ref["gears"][0])
+    $test_store.test_gear2 ||= Dawn::Gear.find(id: $test_store.ref["gears"][1])
+    $test_store.test_gear3 ||= Dawn::Gear.find(id: $test_store.ref["gears"][2])
+  end
+
+  after :all do
+    STDERR.puts "cleaning up"
+    $test_store.delete_field(:test_gear1) rescue nil
+    $test_store.delete_field(:test_gear2) rescue nil
+    $test_store.delete_field(:test_gear3) rescue nil
+  end
+
+  it { should be_a Class }
+
+  describe ".find" do
+    it "should raise an Excon::Errors::NotFound when Gear cannot be found" do
+      expect { subject.find(id: -1) }.to raise_error(Excon::Errors::NotFound)
+    end
+
+    it "should find 1 gear by id" do
+      subject.find(id: $test_store.test_gear1.id)
+    end
+
+    it "should find 1 gear by url" do
+      subject.find(url: $test_store.test_gear2.url)
+    end
+  end
+
+  describe ".destroy" do
+    it "should raise an Excon::Errors::NotFound when Gear cannot be found" do
+      expect { subject.destroy(id: -1) }.to raise_error(Excon::Errors::NotFound)
+    end
+
+    it "should destroy 1 gear by id" do
+      subject.destroy(id: $test_store.test_gear1.id)
+    end
+
+    it "should destroy 1 gear by url" do
+      subject.destroy(url: $test_store.test_gear2.url)
+    end
+  end
+
+  describe ".restart" do
+    it "should restart 1 gear by id" do
+      subject.restart(id: 1)
+    end
+
+    it "should 404 if gear does not exist" do
+      expect { subject.restart(id: -1) }.to raise_error(Excon::Errors::NotFound)
+    end
+  end
+
+  describe "#destroy" do
+    it "should destroy the gear" do
+      $test_store.test_gear3.destroy
+    end
+  end
+end