rappfirst 0.1.0 → 0.2.0

data/.gitignore

@@ -1,3 +1,4 @@
 config.*
 spec/fixtures/**
 Gemfile.lock
+*.gem

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source "https://rubygems.org"
  
 gemspec

data/README.md

@@ -1,24 +1,123 @@
 # Rappfirst
 
-TODO: Write a gem description
+A ruby wrapper for the Appfirst API v3.  Currently implementing the `/servers/` endpoint.  As this is still in beta several parameters are not fully implemented.
+
+**Implemented**
+* `/servers/`
+* `/servers/{id}`
+* `/servers/{id}/tags`
+* `/servers/{id}/polled_data_config`
+* `/servers/{id}/outages`
+
+**TODO**
+* `/servers/{id}/data`
+* `/servers/{id}/processes`
+* `/servers/{id}/auto_detection`
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'rappfirst'
+```ruby
+gem 'rappfirst'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install rappfirst
+```bash
+$ gem install rappfirst
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+All contact with the API starts with connecting via the Client.
+```ruby
+include 'rappfirst'
+c = Rappfirst::Client.new(username="user@example.com", api_key="1234567890")
+```
+
+Get an array of Server Objects
+```ruby
+servers = c.servers
+```
+
+Or query for a single server by hostname
+```ruby
+my_server = c.servers(query_string="?hostname=my-server")
+```
+
+If you know the id, you can just get the server object directly
+```ruby
+my_first_server = c.server('1')
+```
+
+Once you have a Server Object, it's attributes are immediately accessible
+```ruby
+my_server.id
+my_server.architecture
+my_server.hostname
+...
+```
+
+The attributes are a Server Object are read only, except for `nickname` and `description`
+```ruby
+my_server.id = 2 # Fails
+
+my_server.description = "Just an example server"
+# Setting these back on the server is not implemented yet as of 0.1.0
+```
+
+Grab some outage info
+```ruby
+my_server.outages
+```
+
+Refresh your outage info
+```ruby
+my_server.outages(refresh=true)
+```
+
+Check out the tags
+```ruby
+my_server.tags
+my_server.tags(refresh=true)
+```
+
+Set some new tags
+```ruby
+my_server.tags = ["Prod", "Web"]
+# Setting these back on the server is not implemented yet as of 0.1.0
+```
+
+Get your `polled_data_config`. We can't set the polled data config yet due to some API issues. =(
+```ruby
+my_server.polled_data_config
+```
+
+Delete your server.  This will send the API call, but currently does not modify your local copy of the object.
+```ruby
+my_server.delete
+```
+
+All information should be cached locally after the first request or object creation.
+```ruby
+# Cached on creation
+my_server.id
+my_server.hostname
+my_server.architecture
+...
+
+# Cached on method call
+my_server.outages
+my_server.polled_data_config
+my_server.tags
+```
 
 ## Contributing
 
@@ -27,3 +126,5 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+NOTE: Since I haven't had a chance to create a 'clean' set of fixtures, I have not committed the fixture data.  Therefore tests will reference server id's and hostnames that will not exist in your environment.  You will need to fix these to get the tests passing.  I should have a set of clean fixtures added soon.

data/Rakefile

@@ -1,8 +1,21 @@
 require 'rake/testtask'
- 
+require 'bundler/gem_tasks'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks
+
 Rake::TestTask.new do |t|
   t.test_files = FileList['spec/lib/rappfirst/*_spec.rb']
   t.verbose = true
 end
- 
+
 task :default => :test

data/lib/rappfirst/alert.rb

@@ -0,0 +1,81 @@
+module Rappfirst
+  class Alert
+
+    include HTTParty
+    format :json
+
+    attr_accessor :id
+
+    def initialize(id, api_options=nil, json_data=nil)
+      if api_options && api_options.keys.include?(:basic_auth)
+        username = api_options[:basic_auth][:username]
+        api_key = api_options[:basic_auth][:password]
+      else
+        username = get_config('username')
+        api_key = get_config('password')
+      end
+
+      if api_options && api_options.keys.include?(:basic_uri)
+        base_uri = api_options[:base_uri]
+      else
+        base_uri = 'https://wwws.appfirst.com/api/v3'
+      end
+
+      self.class.basic_auth username, api_key
+      self.class.base_uri base_uri
+
+      self.id = id
+      set_attributes(json_data=json_data)
+    end
+
+    def delete
+      delete_self
+    end
+
+    private
+
+      def delete_self
+        response = self.class.delete("/alerts/#{self.id}/")
+        unless response.code == 200
+          raise "Unable to delete server, received HTTP code #{response.code}"
+        end
+      end
+
+      def set_attributes(json_data=nil)
+        if not json_data
+          response = get_attributes
+        else
+          response = json_data
+        end
+        response.each do |name, v|
+          create_method( "#{name}=".to_sym ) { |val|
+            if ! instance_variable_get("@" + name)
+              instance_variable_set("@" + name, val)
+            elsif self.writeable?(name) && instance_variable_get("@" + name)
+              instance_variable_set("@" + name, val)
+            end
+          }
+
+          create_method( name.to_sym ) {
+            instance_variable_get("@" + name)
+          }
+
+          instance_variable_set("@" + name, v)
+        end
+      end
+
+      def get_attributes
+        return self.class.get("/alerts/#{self.id}/")
+      end
+
+      def create_method(name, &block)
+        self.class.send(:define_method, name, &block)
+      end
+
+      def get_config(key)
+        config = YAML::load( File.open('config.yml'))
+        return config[key]
+      end
+
+  end
+end

data/lib/rappfirst/client.rb

@@ -15,7 +15,7 @@ module Rappfirst
 
     def servers(query_string=nil)
       response = get_servers(query_string)
-      if response.length == 1
+      if response.length == 1 && query_string
         return server(response.first['id'])
       else
         s = Array.new
@@ -31,6 +31,20 @@ module Rappfirst
       Rappfirst::Server.new(id, api_options=api_options)
     end
 
+    def alerts
+      response = get_alerts
+      alerts = Array.new
+      response.each do |r|
+        alerts << alert(r['id'], json_data=r)
+      end
+      return alerts
+    end
+
+    def alert(id, json_data=nil)
+      api_options = self.class.default_options
+      Rappfirst::Alert.new(id, api_options=api_options, json_data=json_data)
+    end
+
     private
 
       def get_servers(query_string=nil)
@@ -40,5 +54,9 @@ module Rappfirst
         self.class.get("/servers/#{query_string}")
       end
 
+      def get_alerts
+        self.class.get("/alerts/")
+      end
+
   end
 end

data/lib/rappfirst/server.rb

@@ -12,7 +12,7 @@ module Rappfirst
     def initialize(id, api_options=nil)
       if api_options && api_options.keys.include?(:basic_auth)
         username = api_options[:basic_auth][:username]
-        api_key = api_options[:basic_auth][:api_key]
+        api_key = api_options[:basic_auth][:password]
       else
         username = get_config('username')
         api_key = get_config('password')
@@ -79,7 +79,7 @@ module Rappfirst
       def set_attributes
         response = get_attributes
         response.each do |name, v|
-          create_method( "#{name}=".to_sym ) { |val| 
+          create_method( "#{name}=".to_sym ) { |val|
             if ! instance_variable_get("@" + name)
               instance_variable_set("@" + name, val)
             elsif self.writeable?(name) && instance_variable_get("@" + name)
@@ -87,8 +87,8 @@ module Rappfirst
             end
           }
 
-          create_method( name.to_sym ) { 
-            instance_variable_get("@" + name) 
+          create_method( name.to_sym ) {
+            instance_variable_get("@" + name)
           }
 
           instance_variable_set("@" + name, v)

data/lib/rappfirst/version.rb

@@ -1,3 +1,3 @@
 module Rappfirst
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/lib/rappfirst/alert_spec.rb

@@ -0,0 +1,91 @@
+require_relative '../../spec_helper'
+
+describe Rappfirst::Alert do
+
+  describe "default attributes" do
+
+    let(:alert) { Rappfirst::Alert.new('114140') }
+
+    before do
+      VCR.insert_cassette 'single_alert', :record => :new_episodes
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    it "must include httparty methods" do
+      Rappfirst::Alert.must_include HTTParty
+    end
+
+    it "must have the base url set to the Appfirst API" do
+      alert.class.base_uri.must_equal 'https://wwws.appfirst.com/api/v3'
+    end
+
+    it "must have API Credentials" do
+      alert.class.default_options[:basic_auth].keys.must_include(:username)
+      alert.class.default_options[:basic_auth].keys.must_include(:password)
+    end
+
+  end
+
+
+  describe "attributes" do
+
+    let(:alert) { Rappfirst::Alert.new('114140') }
+
+    before do
+      VCR.insert_cassette 'single_alert', :record => :new_episodes
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    describe "retrieve and create methods" do
+
+      it "must populate the target attribute" do
+        alert.must_respond_to :target
+      end
+
+    end
+
+  end
+
+  describe "delete alert" do
+
+    let(:alert) { Rappfirst::Alert.new('114140') }
+
+    before do
+      VCR.insert_cassette 'single_alert', :record => :new_episodes
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    describe "signature" do
+
+      it "must have a deletion method" do
+        alert.must_respond_to :delete
+      end
+
+    end
+
+    describe "failed deletion" do
+
+      before do
+        stub_request(:any, /wwws.appfirst.com/).
+        to_return(:status => [500, "Internal Server Error"])
+      end
+
+      it "must delete itself" do
+        lambda { alert.delete }.must_raise RuntimeError
+      end
+
+    end
+
+  end
+
+
+end

data/spec/lib/rappfirst/client_spec.rb

@@ -1,19 +1,19 @@
 require_relative '../../spec_helper'
 
 describe Rappfirst::Client do
- 
+
   describe "default attributes" do
- 
+
     it "must include httparty methods" do
       Rappfirst::Client.must_include HTTParty
     end
- 
+
     it "must have the base url set to the Appfirst API" do
       Rappfirst::Client.
       instance_variable_get("@default_options")[:base_uri].
       must_equal 'https://wwws.appfirst.com/api/v3'
     end
- 
+
     it "must have API Credentials" do
       Rappfirst::Client.
       instance_variable_get("@default_options")[:basic_auth].
@@ -21,9 +21,9 @@ describe Rappfirst::Client do
     end
 
   end
- 
+
   describe "GET servers" do
- 
+
     let(:client) { Rappfirst::Client.new }
 
     describe "Get all servers" do
@@ -31,18 +31,14 @@ describe Rappfirst::Client do
       before do
         VCR.insert_cassette 'servers', :record => :new_episodes
       end
-     
+
       after do
         VCR.eject_cassette
       end
-     
+
       it "must have a servers method" do
         client.must_respond_to :servers
       end
-     
-      it "must parse the api response from JSON to Hash" do
-        client.servers.must_be_instance_of Array
-      end
 
       it "should return an array of server objects" do
         client.servers.each { |s| s.must_be_instance_of Rappfirst::Server}
@@ -51,11 +47,11 @@ describe Rappfirst::Client do
     end
 
     describe "Get specific server" do
-      
+
       before do
         VCR.insert_cassette 'search_for_server', :record => :new_episodes
       end
-     
+
       after do
         VCR.eject_cassette
       end
@@ -75,7 +71,7 @@ describe Rappfirst::Client do
   end
 
   describe "Query single server" do
- 
+
     let(:client) { Rappfirst::Client.new }
 
     before do
@@ -96,4 +92,53 @@ describe Rappfirst::Client do
 
   end
 
+  describe "Get single alert" do
+
+    let(:client) { Rappfirst::Client.new }
+
+
+    before do
+      VCR.insert_cassette 'single_alert', :record => :new_episodes
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    it "must have an alerts method" do
+      client.must_respond_to :alert
+    end
+
+    it "must return an alert object" do
+      client.alert('114140').must_be_instance_of Rappfirst::Alert
+    end
+
+  end
+
+  describe "GET alerts" do
+
+    let(:client) { Rappfirst::Client.new }
+
+    describe "Get all alerts" do
+
+      before do
+        VCR.insert_cassette 'alerts', :record => :new_episodes
+      end
+
+      after do
+        VCR.eject_cassette
+      end
+
+      it "must have an alerts method" do
+        client.must_respond_to :alerts
+      end
+
+      it "should return an array of alert objects" do
+        client.alerts.each { |s| s.must_be_instance_of Rappfirst::Alert}
+      end
+
+    end
+
+  end
+
 end

data/spec/lib/rappfirst/server_spec.rb

@@ -1,29 +1,35 @@
 require_relative '../../spec_helper'
 
 describe Rappfirst::Server do
- 
+
   describe "default attributes" do
 
+    let(:server) { Rappfirst::Server.new('11743') }
+
+    before do
+      VCR.insert_cassette 'server', :record => :new_episodes
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
     it "must include httparty methods" do
       Rappfirst::Server.must_include HTTParty
     end
- 
+
     it "must have the base url set to the Appfirst API" do
-      Rappfirst::Server.
-      instance_variable_get("@default_options")[:base_uri].
-      must_equal 'https://wwws.appfirst.com/api/v3'
+      server.class.base_uri.must_equal 'https://wwws.appfirst.com/api/v3'
     end
- 
+
     it "must have API Credentials" do
-      Rappfirst::Client.
-      instance_variable_get("@default_options")[:basic_auth].
-      keys.must_include(:username)
+      server.class.default_options[:basic_auth].keys.must_include(:username)
+      server.class.default_options[:basic_auth].keys.must_include(:password)
     end
 
   end
 
 
-
   describe "attributes" do
 
     let(:server) { Rappfirst::Server.new('11743') }
@@ -31,7 +37,7 @@ describe Rappfirst::Server do
     before do
       VCR.insert_cassette 'server', :record => :new_episodes
     end
-   
+
     after do
       VCR.eject_cassette
     end
@@ -85,7 +91,7 @@ describe Rappfirst::Server do
     before do
       VCR.insert_cassette 'server', :record => :new_episodes
     end
-   
+
     after do
       VCR.eject_cassette
     end
@@ -114,7 +120,7 @@ describe Rappfirst::Server do
       new_data = current_data.clone
       new_data['frequency'] = 600
       server.polled_data = new_data
-      server.polled_data(refresh=true)['frequency'].wont_equal current_data['frequency'] 
+      server.polled_data(refresh=true)['frequency'].wont_equal current_data['frequency']
     end
 
     before do
@@ -131,13 +137,13 @@ describe Rappfirst::Server do
 
 
   describe "outages" do
-    
+
     let(:server) { Rappfirst::Server.new('11743') }
 
     before do
       VCR.insert_cassette 'server', :record => :new_episodes
     end
-     
+
     after do
       VCR.eject_cassette
     end
@@ -178,7 +184,7 @@ describe Rappfirst::Server do
     before do
       VCR.insert_cassette 'server', :record => :new_episodes
     end
-     
+
     after do
       VCR.eject_cassette
     end
@@ -217,13 +223,13 @@ describe Rappfirst::Server do
     before do
       VCR.insert_cassette 'server', :record => :new_episodes
     end
-     
+
     after do
       VCR.eject_cassette
     end
 
     describe "signature" do
-      
+
       it "must have a deletion method" do
         server.must_respond_to :delete
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rappfirst
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2013-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -120,10 +120,12 @@ files:
 - README.md
 - Rakefile
 - lib/rappfirst.rb
+- lib/rappfirst/alert.rb
 - lib/rappfirst/client.rb
 - lib/rappfirst/server.rb
 - lib/rappfirst/version.rb
 - rappfirst.gemspec
+- spec/lib/rappfirst/alert_spec.rb
 - spec/lib/rappfirst/client_spec.rb
 - spec/lib/rappfirst/server_spec.rb
 - spec/spec_helper.rb
@@ -139,12 +141,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2428925126903701848
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2428925126903701848
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -152,6 +160,7 @@ signing_key:
 specification_version: 3
 summary: Appfirst API v3 Wrapper
 test_files:
+- spec/lib/rappfirst/alert_spec.rb
 - spec/lib/rappfirst/client_spec.rb
 - spec/lib/rappfirst/server_spec.rb
 - spec/spec_helper.rb