engineyard-api 0.0.1

data/README.rdoc

@@ -0,0 +1,34 @@
+= Engineyard-API
+* {rubyforge rdoc}[http://tbd]
+* {rubyforge project}[http://tbd]
+* {github project}[http://github.com/tbd]
+
+
+== Installation
+
+... will usually be as simple as:
+
+ gem install engineyard-api
+  
+Or, if you downloaded the archive:  
+
+ gem build engineyard-api
+ gem install engineyard-api-<version>
+
+=== Usage & examples
+
+==== Listing instances
+ require 'engineyard-api'
+ ey = Engineyard.new("API_KEY")
+ environment = ey.environment_by_name("Production")
+ environment.instances.each do |instance|
+   puts instance.id
+ end
+
+===== Multile Accounts
+  require 'engineyard-api'
+  ey = Engineyard.new("API_KEY")
+  account1_environment = ey.account_by_name("Account1").environments.first
+  account2_environment = ey.account_by_id(1234).environment_by_name("production")
+  last_account_environment = ey.accounts.last.environment_by_id(4567)
+

data/lib/engineyard-api.rb

@@ -0,0 +1,9 @@
+require 'httparty'
+require 'json'
+
+require_relative 'engineyard-api/environment.rb'
+require_relative 'engineyard-api/ey_api.rb'
+require_relative 'engineyard-api/instance.rb'
+require_relative 'engineyard-api/app.rb'
+require_relative 'engineyard-api/account.rb'
+require_relative 'engineyard-api/engineyard.rb'

data/lib/engineyard-api/account.rb

@@ -0,0 +1,18 @@
+module EngineyardAPI
+  # Users (and API keys) can have access to multiple accounts.
+  class Account
+  # Returns account id as an Integer
+	attr_reader :id
+  # Returns Account name as a String 
+  attr_reader :name
+  # Returns a list of environments in an Array
+  attr_reader :environments
+  
+  
+  def initialize(account) # :nodoc:
+	  @id = account['id'] if account.has_key? 'id'
+	  @name = account['name'] if account.has_key? 'name'
+	  @environments = account.has_key?(environments) ? account['environments'] : [] 
+	end
+  end
+end

data/lib/engineyard-api/app.rb

@@ -0,0 +1,56 @@
+
+module EngineyardAPI
+  # Class to store application information
+  class App
+
+    def initialize(app) # :nodoc:
+      @app=app
+    end
+
+    # Returns application id in form of an integer
+    def app_id
+      @app['id']
+    end
+
+    # Return account name as string
+    def name 
+      @app['name']
+    end
+    
+    # Return repository associated to application
+    def repository
+      @app['repository_uri']
+    end
+
+    # Returns type of application
+    def app_type 
+      @app['app_type_id']
+    end
+    
+    # Return account id as integer
+    def account_id 
+      @app['account']['id']
+    end
+    
+    # Return account nam eas string
+    def account_name 
+      @app['account']['name']
+    end
+
+    def [](key) # :nodoc:
+      @app['key']
+    end
+
+    def zone # :nodoc:
+      @app['availability_zone']
+    end
+
+    def last_deploy=(deployment) # :nodoc:
+      @last_deploy=deployment
+    end
+
+    def last_deploy # :nodoc:
+      @last_deploy
+    end
+  end
+end

data/lib/engineyard-api/engineyard.rb

@@ -0,0 +1,66 @@
+
+module EngineyardAPI
+  # Create new Engineyard object bassed off supplied options
+  # Example:
+  #  @ey = Engineyard.new(:key => "myapikey")
+  def EngineyardAPI.new(*args)
+	Engineyard.new(*args)
+  end
+  
+  # Main class returned by EngineyardAPI.new(:key => "key")
+  class Engineyard
+	attr_accessor :accounts
+
+
+    def initialize(options)  #:nodoc
+	  @accounts = []
+      raise ArgumentError, "API key not specified. #{self.class}.new(:key => '<api_key>')" unless options.has_key? :key
+      @options=options
+#      @path = "/environments/#{id}"
+      @api = EngineyardAPI::EyAPI.new(@options[:key])
+      EngineyardAPI.const_set("API", @api)
+      reload
+    end
+	
+    ## Call environment information from API. Information is cached in class until reload is called again. Prevents calling API when not needed.
+    def reload
+	  account_list=@api.get("/accounts")['accounts']
+      environment_list=@api.get("/environments")['environments']
+      account_list.each {|a| @accounts << Account.new(a) }
+		environment_list.each {|e|
+		  account_by_id(e['account']['id']).environments << Environment.new(e['id'],e)  
+		}
+      return true
+    end
+    
+    # Returns array of environments
+    def environments
+      return @accounts.map { |account| account.environments }.flatten
+    end 
+    
+    
+    # Find an environment based on name.  Returns EngineyardAPI::Environment 
+    def environment_by_name(name)
+      return environments.select {|e| e.name == name }.first
+    end
+
+    # Find an environment based on name.  Returns EngineyardAPI::Environment
+    def environment_by_id(id)
+      return environments.select {|e| e.environment_id == id }.first
+    end
+    
+    # Find an account based on name.  Returns EngineyardAPI::Account
+    def account_by_id(id)
+	  ac = @accounts.select { |a| a.id == id }
+	  raise "No such account" unless ac.count == 1
+	  return ac[0]
+    end
+
+    # Locate an account by name.  Returns EngineyardAPI::Account
+    def account_by_name(name)
+	  ac = @accounts.select { |a| a.name == name }
+	  raise "No such account" unless ac.count == 1
+	  return ac[0]
+    end
+  end
+end

data/lib/engineyard-api/environment.rb

@@ -0,0 +1,151 @@
+
+module EngineyardAPI
+  # Environment class stores all environment data, and crawls over other parts of the api to grab data for Instance and App classes.
+  class Environment
+    def initialize(id,environment = nil) # :nodoc:
+	  @environment = environment if environment
+      @id = id
+      @path = "/environments/#{id}"
+      #EngineyardAPI::API = EngineyardAPI::API
+      reload(environment)
+    end
+    
+    # Returns integer containing environment ID
+    def environment_id
+      @environment['id']
+    end
+
+    # Returns String containing th eenvironment name
+    def name
+      @environment['name']
+    end
+
+    # Returns number of instances in environment
+    def instance_count
+      @environment['instances_count']
+    end
+
+    # Returns array full of EngineyardAPI::Instnaces
+    def instances
+      @instances
+    end
+
+    # Returns current status
+    def instance_status
+      @environment['instance_status']
+    end
+    
+    # Return load balancer IP address, if any.
+    def load_balancer_ip_address
+      @environment['load_balancer_ip_address']
+    end
+
+    def account # :nodoc:
+      @environment['account']
+    end
+
+    # Name of current stack associated with environment
+    def stack_name
+      @environment['stack_name']
+    end
+
+    # Default user used for deployments (usually 'deploy')
+    def ssh_username
+      @environment['ssh_username']
+    end
+  
+    # Returns current stack name
+    def app_server_stack_name
+      @environment['app_server_stack_name']
+    end
+
+    # Returns framework environment (i.e. "production", or "staging")
+    def framework_env
+      @environment['framework_env']
+    end
+
+    # Returns array of EngineyardAPI::APP's 
+    def apps
+      @applications
+    end
+
+
+    def deployment_configurations
+      @environment['deployment_configurations']
+    end
+
+    # Return EngineyardAPI::Instance of current app_master
+    def app_master
+      @app_master
+    end
+
+    # This was mostly used for testing api. not used in script. keeping for future development reasons.
+    def keys(k=nil) # :nodoc:
+      return  @environment.keys unless k
+      return @environment[k]
+    end
+
+    # Create a new instance.  first param can take any arguments in hash that API would accept (i.e. :instance_size, :volume_size, etc)
+    def add_instance(body)
+      request = {:body => {:request => body}}
+      EngineyardAPI::API.post("#{@path}/add_instances", request)
+    end
+
+    # Checks to see how many add instance actions are working on environment. returns array.
+    def add_status
+      EngineyardAPI::API.get("#{@path}/add_instances")
+    end
+
+    # Remove instance. Provide role (:app, or :util), and :amazon_id if needed.
+    def remove_instance(remove_instance)
+      request = {:body => { :request => {:role => role } } } if [:app,:util].include? remove_instance
+      request = {:body => { :request => { :provisioned_id  => remove_instance.amazon_id } }} unless [:app,:util].include? remove_instance
+      EngineyardAPI::API.post("#{@path}/remove_instances",request)
+    end
+
+    # Same as add_status, except checks for instances being removed. retruns array.
+    def remove_status
+      EngineyardAPI::API.get("#{@path}/remove_instances")
+    end
+
+    # Used for development. same as keys method, but does not return a list of keys if no params.
+    def [](key)
+      @enviornment[key]
+    end
+
+    # Checks if environment is busy. returns true and hash of actions if instances are being added, instances are being removed, or if deploy is ongoing.
+    def busy?
+      return true, {:add_status => add_status["requests"] , :remove_status => remove_status["requests"] } if add_status["requests"].count > 0 or remove_status["requests"].count > 0
+      return false
+    end
+
+    # Checks if environment is deploying (works for standard deploy only (i.e. via dashboard or ey_cli utillity)
+    def deploying?
+      return true if apps.select {|app| app.last_deploy['finished_at'] == nil }.count > 0
+      return false
+    end
+
+    # Like pressing 'apply' on dashboard
+    def rebuild
+      EngineyardAPI::API.put("#{@path}/update_instances",{:body => ""})
+    end
+
+    ## Call environment information from API. Information is cached in class until reload is called again. Prevents calling API when not needed.
+    def reload(e=nil)
+      @environment = EngineyardAPI::API.get(@path)['environment'] unless e
+      @instances = Array.new
+      @applications = Array.new
+      # Populate instances
+      @environment['instances'].each {|instance|
+        @instances << EngineyardAPI::Instance.new(instance)
+      }
+      # Populate Apps
+      @environment['apps'].each {|app|
+        @applications << EngineyardAPI::App.new(app)
+      }
+      @app_master=App.new(@environment['app_master'])
+      @applications.each { |app| app.last_deploy=EngineyardAPI::API.get("/apps/#{app.app_id}/environments/#{environment_id}/deployments/last")['deployment'] }
+      return true
+    end
+  end
+end

data/lib/engineyard-api/ey_api.rb

@@ -0,0 +1,27 @@
+
+module EngineyardAPI
+  # Actually communicates with API.
+  class EyAPI # :nodoc:
+    include HTTParty
+    base_uri 'https://cloud.engineyard.com:443/api/v2/'
+    format :json
+    headers 'Accept' => 'application/json'
+    headers 'Content-Type' => 'application/json'
+
+    def initialize(key = $options[:key]) # :nodoc:
+      @api_key = key
+
+    end
+
+    def get(path) # :nodoc:
+      self.class.get(path, :headers => { 'X-EY-Cloud-Token' => @api_key })
+    end
+
+    def post(path,data) # :nodoc:
+      self.class.post(path,data.merge(:headers=> { 'X-EY-Cloud-Token' => @api_key}))
+    end
+    def put(path,data={}) # :nodoc:
+      self.class.put(path,data.merge(:headers => { 'X-EY-Cloud-Token' => @api_key}))
+    end
+  end
+end

data/lib/engineyard-api/instance.rb

@@ -0,0 +1,59 @@
+module EngineyardAPI
+  # Store information on instances
+  class Instance
+    def initialize(instance) # :nodoc:
+      @instance = instance
+      @logs = EngineyardAPI::API.get "/instances/#{@instance['id']}/logs"
+      @alerts = EngineyardAPI::API.get "/instances/#{@instance['id']}/alerts"
+    end
+    
+    # Return internal ID
+    def instance_id
+      @instance['id']
+    end
+    
+    # Return instance status (i.e. :running, :error, etc)
+    def status
+      @instance['status']
+    end
+    
+    # Return instance role (i.e., app, utility, db, db_master, app_master
+    def role
+      @instance['role']
+    end
+    
+    # Retruns instance nam
+    def name
+      @instance['name']
+    end
+    
+    # Return amazon ID
+    def amazon_id
+      @instance['amazon_id']
+    end
+    
+    # Return instance public hostname
+    def public_hostname
+      @instance['public_hostname']
+    end
+    
+    # Retruns instance zone
+    def zone
+      @instance['availability_zone']
+    end
+    
+    # Returns list of log entries as array
+    def logs
+      return @logs['logs']
+    end
+    def [](key) # :nodoc:
+      @instance['key']
+    end
+    
+    # Returns list of alerts as array
+    def alerts
+      return @alerts['alerts']
+    end
+
+  end
+end

data/lib/engineyard-api/version.rb

@@ -0,0 +1,3 @@
+module EngineyardAPI
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: engineyard-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James Paterni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Wrapper for Egnine Yard API
+email: jpaterni@engineyard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.rdoc
+- lib/engineyard-api/account.rb
+- lib/engineyard-api/app.rb
+- lib/engineyard-api/engineyard.rb
+- lib/engineyard-api/environment.rb
+- lib/engineyard-api/ey_api.rb
+- lib/engineyard-api/instance.rb
+- lib/engineyard-api/version.rb
+- lib/engineyard-api.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby Wrapper for Engine Yard API
+test_files: []