rappfirst 0.1.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+ 
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Gross
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Rappfirst
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rappfirst'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rappfirst
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/rappfirst/*_spec.rb']
+  t.verbose = true
+end
+ 
+task :default => :test

data/lib/rappfirst/client.rb

@@ -0,0 +1,44 @@
+module Rappfirst
+  class Client
+    include HTTParty
+    format :json
+
+    def initialize(username=nil, api_key=nil)
+      if username.nil? || api_key.nil?
+        config = YAML::load( File.open( 'config.yml') )
+        username = config['username']
+        api_key = config['password']
+      end
+      self.class.basic_auth username, api_key
+      self.class.base_uri 'https://wwws.appfirst.com/api/v3'
+    end
+
+    def servers(query_string=nil)
+      response = get_servers(query_string)
+      if response.length == 1
+        return server(response.first['id'])
+      else
+        s = Array.new
+        response.each do |r|
+          s << server(r['id'])
+        end
+        return s
+      end
+    end
+
+    def server(id)
+      api_options = self.class.default_options
+      Rappfirst::Server.new(id, api_options=api_options)
+    end
+
+    private
+
+      def get_servers(query_string=nil)
+        if query_string && ! query_string.start_with?('?')
+          query_string = '?' + query_string
+        end
+        self.class.get("/servers/#{query_string}")
+      end
+
+  end
+end

data/lib/rappfirst/server.rb

@@ -0,0 +1,112 @@
+module Rappfirst
+  class Server
+    include HTTParty
+    format :json
+
+    attr_accessor :id
+
+    def writeable?(name)
+      return ['description', 'nickname'].include?(name)
+    end
+
+    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]
+      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
+    end
+
+    def polled_data(refresh=false)
+      refresh ? @polled_data = get_polled_data : @polled_data ||= get_polled_data
+    end
+
+    def polled_data=(new_polled_data_config)
+      #set_polled_data(new_polled_data_config)
+    end
+
+    def outages(refresh=false)
+      refresh ? @outage_data = get_outage_data : @outage_data ||= get_outage_data
+    end
+
+    def tags(refresh=false)
+      refresh ? @tags = get_tags : @tags ||= get_tags
+    end
+
+    def delete
+      delete_self
+    end
+
+    private
+
+      def delete_self
+        response = self.class.delete("/servers/#{self.id}/")
+        unless response.code == 200
+          raise "Unable to delete server, received HTTP code #{response.code}"
+        end
+      end
+
+      def get_tags
+        return self.class.get("/servers/#{self.id}/tags/")['server_tags']
+      end
+
+      def get_outage_data
+        return self.class.get("/servers/#{self.id}/outages/")
+      end
+
+      def get_polled_data
+        return self.class.get("/servers/#{self.id}/polled_data_config/")
+      end
+
+      def set_polled_data(config)
+        return self.class.put("/servers/#{self.id}/polled_data_config/", config)
+      end
+
+      def set_attributes
+        response = get_attributes
+        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("/servers/#{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/version.rb

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

data/lib/rappfirst.rb

@@ -0,0 +1,5 @@
+require "httparty"
+
+Dir[File.dirname(__FILE__) + '/rappfirst/*.rb'].each do |file|
+  require file
+end

data/rappfirst.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rappfirst/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rappfirst"
+  gem.version       = Rappfirst::VERSION
+  gem.authors       = ["Andrew Gross"]
+  gem.email         = ["andrew.w.gross@gmail.com"]
+  gem.description   = "See Readme.md"
+  gem.summary       = "Appfirst API v3 Wrapper"
+  gem.homepage      = "https://github.com/andrewgross/rappfirst"
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'httparty'
+  
+  gem.add_development_dependency 'debugger'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'turn'
+  gem.add_development_dependency 'rake'
+end

data/spec/lib/rappfirst/client_spec.rb

@@ -0,0 +1,99 @@
+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].
+      keys.must_include(:username)
+    end
+
+  end
+ 
+  describe "GET servers" do
+ 
+    let(:client) { Rappfirst::Client.new }
+
+    describe "Get all servers" 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}
+      end
+
+    end
+
+    describe "Get specific server" do
+      
+      before do
+        VCR.insert_cassette 'search_for_server', :record => :new_episodes
+      end
+     
+      after do
+        VCR.eject_cassette
+      end
+
+      it "must accept query parameters without a question mark" do
+        client.servers(query='hostname=yipit-linkedin-worker2').
+        must_be_instance_of Rappfirst::Server
+      end
+
+      it "should return a server object" do
+        client.servers(query='?hostname=yipit-linkedin-worker2').
+        must_be_instance_of Rappfirst::Server
+      end
+
+    end
+
+  end
+
+  describe "Query single server" do
+ 
+    let(:client) { Rappfirst::Client.new }
+
+    before do
+      VCR.insert_cassette 'single_server', :record => :new_episodes
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    it "must have a server method" do
+      client.must_respond_to :server
+    end
+
+    it "must return a server object" do
+      client.server('11743').must_be_instance_of Rappfirst::Server
+    end
+
+  end
+
+end

data/spec/lib/rappfirst/server_spec.rb

@@ -0,0 +1,248 @@
+require_relative '../../spec_helper'
+
+describe Rappfirst::Server do
+ 
+  describe "default attributes" do
+
+    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'
+    end
+ 
+    it "must have API Credentials" do
+      Rappfirst::Client.
+      instance_variable_get("@default_options")[:basic_auth].
+      keys.must_include(:username)
+    end
+
+  end
+
+
+
+  describe "attributes" do
+
+    let(:server) { Rappfirst::Server.new('11743') }
+
+    before do
+      VCR.insert_cassette 'server', :record => :new_episodes
+    end
+   
+    after do
+      VCR.eject_cassette
+    end
+
+    describe "retrieve and create methods" do
+
+      it "must populate the hostname attribute" do
+        server.must_respond_to :hostname
+      end
+
+      it "must make the hostname attribute read-only" do
+        h = server.hostname
+        server.hostname = "foobar"
+        server.hostname.must_equal h
+      end
+
+      it "must populate the nickname attribute" do
+        server.must_respond_to :nickname
+      end
+
+      it "must make the nickname attribute writeable" do
+        n = server.nickname
+        server.nickname = "foobar"
+        server.nickname.wont_equal n
+      end
+
+    end
+
+    describe "cache data" do
+
+      before do
+        server.polled_data
+        stub_request(:any, /wwws.appfirst.com/).to_timeout
+      end
+
+      it "must cache attributes" do
+        skip "TODO: Implement Refreshing of base attributes"
+        lambda { server.hostname }.must_raise Timeout::Error
+      end
+
+    end
+
+  end
+
+
+
+  describe "polled data config" 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 have a polled data method" do
+      server.must_respond_to :polled_data
+    end
+
+    it "must fetch the current polled data config" do
+      server.polled_data.must_be_instance_of Hash
+    end
+
+    it "must have proper results" do
+      ["file_type", "file_contents", "server_id", "file_path", "frequency"].each do |key|
+        server.polled_data.keys.must_include(key)
+      end
+    end
+
+    it "must have a polled data setter" do
+      server.must_respond_to :polled_data=
+    end
+
+    it "must upload new configs" do
+      skip "API is returning 500 Errors"
+      current_data = server.polled_data.clone
+      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'] 
+    end
+
+    before do
+      server.polled_data
+      stub_request(:any, /wwws.appfirst.com/).to_timeout
+    end
+
+    it "must refresh the results if forced" do
+      lambda { server.polled_data(refresh=true) }.must_raise Timeout::Error
+    end
+
+  end
+
+
+
+  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
+
+    describe "retrieve outages" do
+
+      it "must have an outages method" do
+        server.must_respond_to :outages
+      end
+
+      it "must retrieve outage data" do
+        server.outages.must_be_instance_of Array
+      end
+
+    end
+
+    describe "cached data" do
+
+      before do
+        server.outages
+        stub_request(:any, /wwws.appfirst.com/).to_timeout
+      end
+
+      it "must cache outage data" do
+        lambda { server.outages(refresh = true) }.must_raise Timeout::Error
+      end
+
+    end
+
+  end
+
+
+
+  describe "tags" do
+
+    let(:server) { Rappfirst::Server.new('11743') }
+
+    before do
+      VCR.insert_cassette 'server', :record => :new_episodes
+    end
+     
+    after do
+      VCR.eject_cassette
+    end
+
+    describe "retrieve tags" do
+
+      it "must have a tags method" do
+        server.must_respond_to :tags
+      end
+
+      it "must retrieve tag data" do
+        server.tags.must_be_instance_of Array
+      end
+
+    end
+
+    describe "cached data" do
+
+      before do
+        server.tags
+        stub_request(:any, /wwws.appfirst.com/).to_timeout
+      end
+
+      it "must cache outage data" do
+        lambda { server.tags(refresh = true) }.must_raise Timeout::Error
+      end
+
+    end
+
+  end
+
+  describe "delete server" do
+
+    let(:server) { Rappfirst::Server.new('245342') }
+
+    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
+
+    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 { server.delete }.must_raise RuntimeError
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require_relative "../lib/rappfirst"
+
+require 'minitest/autorun'
+require "minitest/spec"
+require 'webmock/minitest'
+require 'vcr'
+require 'turn'
+
+# Turn Config
+Turn.config do |c|
+ # :outline  - turn's original case/test outline mode [default]
+ c.format  = :outline
+ # use humanized test names (works only with :outline format)
+ c.natural = true
+end
+
+# VCR config
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/rappfirst_cassettes'
+  c.hook_into :webmock
+end
+

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: rappfirst
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Gross
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-06 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: debugger
+  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: vcr
+  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: turn
+  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: 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'
+description: See Readme.md
+email:
+- andrew.w.gross@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rappfirst.rb
+- lib/rappfirst/client.rb
+- lib/rappfirst/server.rb
+- lib/rappfirst/version.rb
+- rappfirst.gemspec
+- spec/lib/rappfirst/client_spec.rb
+- spec/lib/rappfirst/server_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/andrewgross/rappfirst
+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.23
+signing_key: 
+specification_version: 3
+summary: Appfirst API v3 Wrapper
+test_files:
+- spec/lib/rappfirst/client_spec.rb
+- spec/lib/rappfirst/server_spec.rb
+- spec/spec_helper.rb