dawn-api 0.9.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f67aba9063e02175a8f39faef656f1046d01a474
-  data.tar.gz: 1b4424a7e02702a2acf8625162e30f233f58c6ea
+  metadata.gz: fe30248ae573868bf991429cda95c8dfceec4bf7
+  data.tar.gz: 161aa1267f3bbc2d5e4a08b79db80157a411033f
 SHA512:
-  metadata.gz: c680999789ae45609b11fc9e311ae2a9a09437b9d182ab1d0beb5c30f0b9111e06466d364e3a85047bd6d16b52d6fed140d9abc7790fff925680442016e3e779
-  data.tar.gz: 569ba8aab02dbd02e00952dcca4b32d5d6f251222d3ae8047ad448c0f748fe882bb3e781ccac24f7ed2d5441ea6ab496203683855b42db4fd3b75d4c6bef1e77
+  metadata.gz: bf6133ff0aa98e30f1d1f5b795b411e44aced402bcb524cdb836c01eb8978003b91f67c7038e1e4074761c1b2a1e673f2a5736d861c2b59ec80fb77b04c75309
+  data.tar.gz: 465a63b82801693130763868a26707871adbc88985e953c705d3bf9f54c0f9793cd488122b1c9d06bcc91913bf7215d45802ec47da26b75c6f4aef4852f0f4c3

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+Overview
+========

data/README.md

@@ -0,0 +1,49 @@
+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)
+
+API for [Dawn](https://github.com/dawn/dawn)
+
+## Installation
+```shell
+gem install dawn-api
+```
+
+## Building
+```shell
+gem pack dawn-api.gem
+```
+
+## Documentation:
+[Rubydoc](http://rubydoc.info/gems/dawn-api)
+
+[API Reference](http://dawn.github.io/docs/)
+
+## Influential ENV variable
+| VAR           | API default   | Description                                                |
+| ------------- | ------------- | ---------------------------------------------------------- |
+| DAWN_HOST     | dawn.dev      | Main hostname                                              |
+| DAWN_SCHEME   | http          |                                                            |
+| DAWN_API_HOST | api.dawn.dev  | Dawn API hostname, if not given, api.$DAWN_HOST is used    |
+| DAWN_GIT_HOST | dawn.dev      | Target for git push dawn, if not given, $DAWN_HOST is used |
+| DAWN_LOG_HOST | dawn.dev:8001 | Dawn logs hostname, if not given, $DAWN_HOST:8001 is used  |
+
+## What is this?
+This is the ruby API interface for [Dawn](https://github.com/dawn/dawn),
+- It is not a standalone gem.
+- It requires a dawn server.
+- It is not a CLI, look at [Dawn-CLI](https://github.com/dawn/dawn-cli) instead
+
+## Usage
+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.gears.restart
+```

data/lib/dawn/api/authenticate.rb

@@ -1,4 +1,5 @@
 require 'dawn/api/version'
+require 'base64'
 require 'excon'
 require 'netrc'
 
@@ -15,21 +16,29 @@ module Dawn
 
   OPTIONS = {
     headers:  {},
-    host:     'api.dawn.dev',
     nonblock: false,
-    scheme:   'http'
   }
 
   class AuthenticationError < RuntimeError
   end
 
+  class << self
+    attr_accessor :last_response_body
+  end
+
   def self.request(options)
     Dawn.authenticate unless @connection
-    @connection.request(options)
+    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
   end
 
   def self.authenticate(options={})
-    options = OPTIONS.merge options
+    options = OPTIONS.merge(host: dawn_api_host, scheme: dawn_scheme).merge(options)
     options[:headers] = options[:headers].merge(HEADERS)
     @api_key = options.delete(:api_key) || ENV['DAWN_API_KEY']
 
@@ -59,7 +68,9 @@ module Dawn
         end
       end
     end
-    @headers = HEADERS.merge 'Authorization' => "Token token=\"#{@api_key}\""
+    @headers = HEADERS.merge(
+      'Authorization' => "Basic #{::Base64.strict_encode64("#{username}:#{@api_key}")}"
+    )
     @connection = Excon.new "#{options[:scheme]}://#{options[:host]}", headers: @headers
   end
 

data/lib/dawn/api/base_api.rb

@@ -3,21 +3,42 @@ require 'json'
 
 module Dawn
   module BaseApi
-    module Extension
+    module RequestExtension
       def request(options)
-        Dawn.request options
+        options[:expects] = 200 unless options.key?(:expects)
+        JSON.load Dawn.request(options).body
       end
 
-      def json_request(options)
-        JSON.load request(options).body
+      [:get, :post, :put, :patch, :delete].each do |key|
+        define_method(key) { |options| request options.merge(method: key) }
       end
     end
 
-    include Extension
+    module ClassExtension
+      include RequestExtension
+
+      def id_param(options)
+        options.delete(:id)
+      end
+
+      def data_key(key_name, key_path=key_name)
+        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
+        define_method(key_name.to_s+"=") do |v|
+          route_dp.inject(@data) { |d, key| d[key] }[last_key] = v
+        end
+      end
+    end
 
     def self.included(mod)
-      mod.extend Extension
+      mod.extend ClassExtension
     end
 
+    include RequestExtension
   end
 end

data/lib/dawn/api/hosts.rb

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

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

@@ -0,0 +1,43 @@
+require 'dawn/api/base_api'
+
+module Dawn
+  class Account
+
+    include BaseApi
+
+    def initialize(hsh)
+      @data = hsh
+    end
+
+    data_key :id
+    data_key :created_at
+    data_key :updated_at
+    data_key :username
+    data_key :email
+    data_key :api_key
+
+    def refresh(options={})
+      @data = get(
+        path: "/account",
+        query: options
+      )["account"]
+    end
+
+    def update(options={})
+      options.fetch(:account)
+
+      @data = patch(
+        path: "/account",
+        body: options.to_json
+      )["account"]
+    end
+
+    def self.current(options={})
+      new get(
+        path: "/account",
+        query: options
+      )["account"]
+    end
+
+  end
+end

data/lib/dawn/api/{app → models/app}/domains.rb

@@ -1,11 +1,12 @@
 require 'dawn/api/base_api'
-require 'dawn/api/domain'
+require 'dawn/api/models/domain'
 
 module Dawn
   class App
     class Domains
 
       include BaseApi
+      include Enumerable
 
       attr_reader :app
 
@@ -13,25 +14,27 @@ module Dawn
         @app = app
       end
 
-      def create(options={})
-        Domain.new(json_request(
-          expects: 200,
-          method: :post,
+      def each(&block)
+        all.each(&block)
+      end
+
+      def create(options)
+        options.fetch(:domain)
+
+        Domain.new(post(
           path: "/apps/#{app.id}/domains",
           body: options.to_json
         )["domain"]).tap { |d| d.app = @app }
       end
 
       def all(options={})
-        json_request(
-          expects: 200,
-          method: :get,
+        get(
           path: "/apps/#{app.id}/domains",
           query: options
         ).map { |hsh| Domain.new(hsh["domain"]).tap { |d| d.app = @app } }
       end
 
-      def find(options={})
+      def find(options)
         Domain.find(options).tap { |d| d.app = @app }
       end
 

data/lib/dawn/api/{app → models/app}/drains.rb

@@ -1,11 +1,12 @@
 require 'dawn/api/base_api'
-require 'dawn/api/drain'
+require 'dawn/api/models/drain'
 
 module Dawn
   class App
     class Drains
 
       include BaseApi
+      include Enumerable
 
       attr_reader :app
 
@@ -13,19 +14,21 @@ module Dawn
         @app = app
       end
 
+      def each(&block)
+        all.each(&block)
+      end
+
       def create(options={})
-        Drain.new(json_request(
-          expects: 200,
-          method: :post,
+        options.fetch(:drain)
+
+        Drain.new(post(
           path: "/apps/#{app.id}/drains",
           body: options.to_json
         )["drain"]).tap { |d| d.app = @app }
       end
 
       def all(options={})
-        json_request(
-          expects: 200,
-          method: :get,
+        get(
           path: "/apps/#{app.id}/drains",
           query: options
         ).map { |hsh| Drain.new(hsh["drain"]).tap { |d| d.app = @app } }

data/lib/dawn/api/{app → models/app}/env.rb

@@ -15,20 +15,16 @@ module Dawn
       end
 
       def refresh(options={})
-        replace json_request(
-          expects: 200,
-          method: :get,
+        replace get(
           path: "/apps/#{app.id}/env",
           query: options
         )["env"]
       end
 
       def save(options={})
-        replace json_request(
-          expects: 200,
-          method: :post,
+        replace post(
           path: "/apps/#{app.id}/env",
-          body: { env: merge(options) }.to_json
+          body: { app: { env: merge(options) } }.to_json
         )["env"]
       end
 

data/lib/dawn/api/{app → models/app}/gears.rb

@@ -1,11 +1,12 @@
 require 'dawn/api/base_api'
-require 'dawn/api/gear'
+require 'dawn/api/models/gear'
 
 module Dawn
   class App
     class Gears
 
       include BaseApi
+      include Enumerable
 
       attr_reader :app
 
@@ -13,19 +14,21 @@ module Dawn
         @app = app
       end
 
+      def each(&block)
+        all.each(&block)
+      end
+
       def create(options={})
-        Gear.new(json_request(
-          expects: 200,
-          method: :post,
+        options.fetch(:gear)
+
+        Gear.new(post(
           path: "/apps/#{app.id}/gears",
           body: options.to_json
         )["gear"]).tap { |d| d.app = @app }
       end
 
       def all(options={})
-        json_request(
-          expects: 200,
-          method: :get,
+        get(
           path: "/apps/#{app.id}/gears",
           query: options
         ).map { |hsh| Gear.new(hsh["gear"]).tap { |d| d.app = @app } }
@@ -36,9 +39,7 @@ module Dawn
       end
 
       def restart(options={})
-        request(
-          expects: 200,
-          method: :post,
+        post(
           path: "/apps/#{app.id}/gears/restart",
           body: options.to_json
         )

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

@@ -0,0 +1,43 @@
+require 'dawn/api/base_api'
+require 'dawn/api/models/release'
+
+module Dawn
+  class App
+    class Releases
+
+      include BaseApi
+      include Enumerable
+
+      attr_reader :app
+
+      def initialize(app)
+        @app = app
+      end
+
+      def each(&block)
+        all.each(&block)
+      end
+
+      def create(options={})
+        options.fetch(:release)
+
+        Release.new(post(
+          path: "/apps/#{app.id}/releases",
+          body: options.to_json
+        )["release"]).tap { |d| d.app = @app }
+      end
+
+      def all(options={})
+        get(
+          path: "/apps/#{app.id}/releases",
+          query: options
+        ).map { |hsh| Release.new(hsh["release"]).tap { |d| d.app = @app } }
+      end
+
+      def find(options={})
+        Release.find(options).tap { |d| d.app = @app }
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,172 @@
+require 'dawn/api/hosts'
+require 'dawn/api/base_api'
+require 'dawn/api/models/app/env'
+require 'dawn/api/models/app/gears'
+require 'dawn/api/models/app/drains'
+require 'dawn/api/models/app/domains'
+require 'dawn/api/models/app/releases'
+
+module Dawn
+  class App
+
+    include BaseApi
+
+    attr_reader :data
+    attr_reader :env
+
+    def initialize(hsh)
+      @data = hsh
+      @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
+
+    def gears
+      @gears ||= Gears.new self
+    end
+
+    def drains
+      @drains ||= Drains.new self
+    end
+
+    def domains
+      @domains ||= Domains.new self
+    end
+
+    def releases
+      @releases ||= Releases.new self
+    end
+
+    def refresh(options={})
+      @data = get(
+        path: "/apps/#{id}",
+        query: options
+      )["app"]
+    end
+
+    def update(options={})
+      options.fetch(:app)
+
+      @data = patch(
+        path: "/apps/#{id}",
+        body: options.to_json
+      )["app"]
+    end
+
+    def destroy(options={})
+      self.class.destroy(options.merge(id: id))
+    end
+
+    def run(options={})
+      self.class.run(options.merge(id: id))
+    end
+
+    def logs(options={})
+      self.class.logs(options.merge(id: id))
+    end
+
+    def scale(options={})
+      self.class.scale(options.merge(id: id))
+    end
+
+    def restart(options={})
+      self.class.restart(options.merge(id: id))
+    end
+
+    def self.id_param(options)
+      options.delete(:id) ||
+      options.delete(:name) ||
+      raise
+    end
+
+    def self.create(options)
+      options.fetch(:app)
+
+      new post(
+        path: "/apps",
+        body: options.to_json
+      )["app"]
+    end
+
+    def self.all(options={})
+      get(
+        path: "/apps",
+        query: options
+      ).map { |d| new d["app"] }
+    end
+
+    def self.find(options)
+      id = id_param(options)
+
+      new get(
+        path: "/apps/#{id}",
+        query: options
+      )["app"]
+    end
+
+    def self.update(options)
+      id = id_param(options)
+      options.fetch(:app)
+
+      new patch(
+        path: "/apps/#{id}",
+        body: options.to_json
+      )["app"]
+    end
+
+    def self.destroy(options={})
+      id = id_param(options)
+
+      delete(
+        path: "/apps/#{id}",
+        query: options
+      )
+    end
+
+    def self.restart(options={})
+      id = id_param(options)
+
+      post(
+        path: "/apps/#{id}/gears/restart",
+        body: options.to_json
+      )
+    end
+
+    def self.logs(options={})
+      id = id_param(options)
+
+      url = get(
+        path: "/apps/#{id}/logs",
+        query: options
+      )["logs"]
+
+      "http://#{Dawn.log_host}#{url}"
+    end
+
+    def self.scale(options={})
+      id = id_param(options)
+      options.fetch(:app).fetch(:formation)
+
+      post(
+        path: "/apps/#{id}/scale",
+        body: options.to_json
+      )
+    end
+
+    def self.run(options={})
+      id = id_param(options)
+      options.fetch(:command)
+
+      post(
+        path: "/apps/#{id}/run",
+        body: options.to_json
+      )
+    end
+
+  end
+end

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

@@ -0,0 +1,64 @@
+require 'dawn/api/base_api'
+
+module Dawn
+  class Domain
+
+    include BaseApi
+
+    attr_reader :data
+    attr_writer :app
+
+    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"
+
+    def app
+      @app ||= App.find(id: app_id)
+    end
+
+    def refresh
+      @data = get(
+        path: "/domains/#{id}",
+        query: options
+      )["domain"]
+    end
+
+    def destroy(options={})
+      self.class.destroy(options.merge(id: id))
+    end
+
+    def self.id_param(options)
+      id = options.delete(:id) ||
+      options.delete(:name) ||
+      options.delete(:uri) ||
+      options.delete(:url) ||
+      raise
+    end
+
+    def self.find(options)
+      id = id_param(options)
+
+      new get(
+        path: "/domains/#{id}",
+        query: options
+      )["domain"]
+    end
+
+    def self.destroy(options)
+      id = id_param(options)
+
+      delete(
+        path: "/domains/#{id}",
+        query: options
+      )
+    end
+
+  end
+end