ivapi 1.0.4 → 1.1.0

data/lib/ivapi/configuration.rb

@@ -3,42 +3,48 @@ require 'ivapi/version'
 
 module Ivapi
   module Configuration
-    VALID_OPTIONS_KEYS = [
-      :adapter,
-      :faraday_config_block,
-      :username,
-      :password,
-      :user_agent,
-      :server_id
-    ].freeze
-
-    DEFAULT_ADAPTER = Faraday.default_adapter
-    DEFAULT_USER_AGENT = "Ivapi Ruby Gem #{Ivapi::VERSION}".freeze
-
-    attr_accessor(*VALID_OPTIONS_KEYS)
-
-    def self.extended(base)
-      base.reset
+
+    attr_accessor :server_id, :user_agent, :connection_options,
+                  :web_endpoint, :api_endpoint
+    attr_writer :username, :password
+
+    def self.keys
+      @keys ||= [
+        :api_endpoint,
+        :server_id,
+        :username,
+        :middleware,
+        :password,
+        :user_agent,
+        :connection_options
+      ]
     end
 
     def configure
       yield self
     end
 
-    def options
-      VALID_OPTIONS_KEYS.reduce({}) { |a, e| a.merge!(e => send(e)) }
+    # Reset configuration options to default values
+    def reset!
+      Ivapi::Configuration.keys.each do |key|
+        instance_variable_set(:"@#{key}", Ivapi::Default.options[key])
+      end
+      self
     end
+    alias setup reset!
 
-    def faraday_config(&block)
-      @faraday_config_block = block
+    def configure
+      yield self
     end
 
-    def reset
-      self.adapter = DEFAULT_ADAPTER
-      self.username = nil
-      self.password = nil
-      self.server_id = nil
-      self.user_agent = DEFAULT_USER_AGENT
+    private
+
+    def options
+      Hash[
+        Ivapi::Configuration.keys.map do |key|
+          [key, instance_variable_get(:"@#{key}")]
+        end
+      ]
     end
   end
 end

data/lib/ivapi/default.rb

@@ -0,0 +1,86 @@
+require 'faraday_middleware'
+require 'ivapi/response/raise_error'
+require 'ivapi/response/rename_keys'
+require 'ivapi/version'
+
+module Ivapi
+
+  # Default configuration options for {Client}
+  module Default
+    # Default API endpoint
+    API_ENDPOINT = 'https://api.iv.lt'.freeze
+
+    # Default User Agent header string
+    USER_AGENT   = "Ivapi ruby gem v#{Ivapi::VERSION}".freeze
+
+    # In Faraday 0.9, Faraday::Builder was renamed to Faraday::RackBuilder
+    RACK_BUILDER_CLASS = if defined?(Faraday::RackBuilder)
+      Faraday::RackBuilder
+    else
+      Faraday::Builder
+    end
+
+    # Default Faraday middleware stack
+    MIDDLEWARE = RACK_BUILDER_CLASS.new do |builder|
+      builder.request :json
+      builder.use Ivapi::Response::RaiseError
+      builder.use FaradayMiddleware::FollowRedirects
+      builder.use FaradayMiddleware::Mashify
+      builder.use Ivapi::Response::RenameKeys
+      builder.use FaradayMiddleware::ParseJson
+      builder.adapter Faraday.default_adapter
+    end
+
+    class << self
+
+      # Configuration options
+      # @return [Hash]
+      def options
+        Hash[Ivapi::Configuration.keys.map { |key| [key, send(key)] }]
+      end
+
+       # Default GitHub username for Basic Auth from ENV
+      # @return [String]
+      def username
+        ENV['IVAPI_USERNAME']
+      end
+
+      def server_id
+        nil
+      end
+
+      # Default middleware stack for Faraday::Connection
+      # from {MIDDLEWARE}
+      # @return [String]
+      def middleware
+        MIDDLEWARE
+      end
+
+      # Default GitHub password for Basic Auth from ENV
+      # @return [String]
+      def password
+        ENV['IVAPI_PASSWORD']
+      end
+
+      def connection_options
+        {
+          headers: {
+            user_agent: user_agent
+          }
+        }
+      end
+
+      # Default User-Agent header string from ENV or {USER_AGENT}
+      # @return [String]
+      def user_agent
+        ENV['IVAPI_USER_AGENT'] || USER_AGENT
+      end
+
+      # Default API endpoint from ENV or {API_ENDPOINT}
+      # @return [String]
+      def api_endpoint
+        ENV['IVAPI_API_ENDPOINT'] || API_ENDPOINT
+      end
+    end
+  end
+end

data/lib/ivapi/error.rb

@@ -1,6 +1,24 @@
 module Ivapi
-
   class Error < StandardError
+    # Returns the appropriate Ivapi::Error sublcass based
+    # on status and response message.
+    #
+    # response - The Hash of HTTP response.
+    #
+    # Returns the Ivapi::Error.
+    def self.from_response(response)
+      status  = response[:status].to_i
+      body    = response[:body].to_s
+      headers = response[:response_headers]
+
+      if klass = case status
+                 when 400 then Ivapi::BadRequest
+                 when 401 then Ivapi::Unauthorized
+                 when 403 then Ivapi::Forbidden
+                 end
+        klass.new(response)
+      end
+    end
   end
 
   # Raised when iv.lt returns a 400 HTTP status code
@@ -11,25 +29,4 @@ module Ivapi
 
   # Raised when iv.lt returns a 403 HTTP status code
   class Forbidden < Error; end
-
-  # Raised when iv.lt returns a 404 HTTP status code
-  class NotFound < Error; end
-
-  # Raised when iv.lt returns a 406 HTTP status code
-  class NotAcceptable < Error; end
-
-  # Raised when iv.lt returns a 422 HTTP status code
-  class UnprocessableEntity < Error; end
-
-  # Raised when iv.lt returns a 500 HTTP status code
-  class InternalServerError < Error; end
-
-  # Raised when iv.lt returns a 501 HTTP status code
-  class NotImplemented < Error; end
-
-  # Raised when iv.lt returns a 502 HTTP status code
-  class BadGateway < Error; end
-
-  # Raised when iv.lt returns a 503 HTTP status code
-  class ServiceUnavailable < Error; end
 end

data/lib/ivapi/response/raise_error.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+require 'ivapi/error'
+
+module Ivapi
+  # Faraday response middleware
+  module Response
+
+    # This class raises an exception based HTTP status codes returned
+    # by the API.
+    class RaiseError < Faraday::Response::Middleware
+
+      private
+
+      def on_complete(response)
+        if error = Ivapi::Error.from_response(response)
+          raise error
+        end
+      end
+    end
+  end
+end

data/lib/ivapi/response/rename_keys.rb

@@ -0,0 +1,38 @@
+require 'faraday'
+
+module Ivapi
+  # Faraday response middleware
+  module Response
+    class RenameKeys < Faraday::Response::Middleware
+      UNUSED_KEYS = [
+        'ac_', 'us_', 'bo_', 'or_', 'se_', 'ta_', 'in_'
+     ].freeze
+
+      private
+
+      def on_complete(response)
+        response[:body] = rename_keys(response[:body])
+      end
+
+      def rename_keys(input)
+        if input.is_a?(Hash)
+          new = {}
+          input.map do |key, value|
+            if value.is_a?(Hash)
+              value = rename_keys(value)
+            elsif value.is_a?(Array)
+              value = value.map { |v| rename_keys(v) }
+            end
+
+            new[key.gsub(Regexp.union(UNUSED_KEYS), '')] = value
+          end
+          new
+        elsif input.is_a?(Array)
+          input.map { |value| rename_keys(value) }
+        else
+          input
+        end
+      end
+    end
+  end
+end

data/lib/ivapi/version.rb

@@ -1,3 +1,3 @@
 module Ivapi
-  VERSION = '1.0.4'
+  VERSION = '1.1.0'
 end

data/spec/ivapi/client/account_spec.rb

@@ -1,47 +1,81 @@
 require 'spec_helper'
 
 describe Ivapi::Client::Account do
-
-  before do
-    @client = Ivapi::Client.new(username: 'foo', password: 'bar')
+  before(:each) do
+    Ivapi.configure do |config|
+      config.username = 'foo'
+      config.password = 'bar'
+    end
   end
 
-  it 'returns account information' do
-    stub_command('account_info').to_return(json_response('account_info.json'))
+  after(:each) do
+    Ivapi.reset!
+  end
 
-    account_info = @client.account_info
+  describe 'account information' do
+    before(:each) do
+      stub_command('account_info')
+       .to_return(json_response('account_info.json'))
+      @info = Ivapi.account.information
+    end
 
-    expect(account_info.ac_name).to eq('Name Surname')
+    it 'should return account name' do
+      expect(@info.name).to eq('Name Surname')
+    end
   end
 
-  it 'returns account orders' do
-    stub_command('account_orders')
-      .to_return(json_response('account_orders.json'))
+  describe 'account orders' do
+    before(:each) do
+      stub_command('account_orders')
+        .to_return(json_response('account_orders.json'))
+      @account_orders = Ivapi.account.orders
+      @order = @account_orders.first
+    end
 
-    account_orders = @client.account_orders
+    it 'should return correct orders count' do
+      expect(@account_orders.count).to eq(3)
+    end
 
-    expect(account_orders.count).to eq(3)
-    expect(account_orders.first.or_cost).to eq('11.11')
+    it 'should return order cost' do
+      expect(@order.cost).to eq('11.11')
+    end
   end
 
-  it 'returns account services' do
-    stub_command('account_services')
-      .to_return(json_response('account_services.json'))
+  describe 'account services' do
+    before(:each) do
+      stub_command('account_services')
+        .to_return(json_response('account_services.json'))
+      @account_services = Ivapi.account.services
+      @service = @account_services.first
+    end
 
-    account_services = @client.account_services
+    it 'should return correct services count' do
+      expect(@account_services.count).to eq(3)
+    end
 
-    expect(account_services.count).to eq(3)
-    expect(account_services.first.se_description)
-      .to eq('Adreso metinis mokestis (example.com)')
+    it 'should return service description' do
+      expect(@service.description)
+        .to eq('Adreso metinis mokestis (example.com)')
+    end
   end
 
-  it 'returns account bonuses' do
-    stub_command('account_bonuses', { count: 10 })
-      .to_return(json_response('account_bonuses.json'))
+  it 'returns account credits'
+
+  describe 'account bonuses' do
+    before(:each) do
+      stub_command('account_bonuses', count: 10)
+       .to_return(json_response('account_bonuses.json'))
+      @account_bonuses = Ivapi.account.bonuses
+      @bonus = @account_bonuses[2]
+    end
 
-    account_bonuses = @client.account_bonuses
+    it 'should return correct bonuses count' do
+      expect(@account_bonuses.count).to eq(3)
+    end
 
-    expect(account_bonuses[2].bo_description)
-      .to eq('SMS +370.61234569 (example)')
+    it 'should return bonus description' do
+      expect(@bonus.description)
+        .to eq('SMS +370.61234569 (example)')
+    end
   end
 end

data/spec/ivapi/client/server_spec.rb

@@ -1,94 +1,167 @@
 require 'spec_helper'
 
 describe Ivapi::Client::Server do
+  before(:each) do
+    Ivapi.configure do |config|
+      config.username = 'foo'
+      config.password = 'bar'
+      config.server_id = 3
+    end
+  end
 
-  before do
-    @client = Ivapi::Client.new(username: 'foo', password: 'bar', server_id: 3)
+  after(:each) do
+    Ivapi.reset!
   end
 
-  it 'should return server information' do
-    stub_command('server_info', { id: 3 })
-      .to_return(json_response('server_info.json'))
-    server_info = @client.server_info
-    expect(server_info.se_domain).to eq('server.example.com')
-    expect(server_info.se_info.in_node).to eq('Robinija')
+  describe 'server information' do
+    before(:each) do
+      stub_command('server_info', id: 3)
+        .to_return(json_response('server_info.json'))
+      @info = Ivapi.server.information
+    end
+
+    it 'should response with alias method' do
+      expect(Ivapi.server.info.domain).to eq('server.example.com')
+    end
+
+    it 'should return domain name' do
+      expect(@info.domain).to eq('server.example.com')
+    end
+
+    it 'should return node name' do
+      expect(@info.info.node).to eq('Robinija')
+    end
   end
 
-  it 'should return server tasks' do
-    stub_command('server_tasks', { id: 3, count: 1 })
-      .to_return(json_response('server_tasks.json'))
-    server_tasks = @client.server_tasks(1)
-    expect(server_tasks.first.ta_params.domain).to eq('server.example.com')
+  describe 'server tasks' do
+    before(:each) do
+      stub_command('server_tasks', id: 3, count: 1)
+        .to_return(json_response('server_tasks.json'))
+      @tasks = Ivapi.server.tasks(1)
+      @task = @tasks.first
+    end
+
+    it 'should return params domain name' do
+      expect(@task.params.domain).to eq('server.example.com')
+    end
+  end
+
+  describe 'server graphs' do
+    before(:each) do
+      stub_command('server_graphs', id: 3, width: 1000, ip: '12.23.34.45')
+        .to_return(json_response('server_graphs.json'))
+      @graphs = Ivapi.server.graphs(1000, '12.23.34.45')
+    end
+
+    it 'should return cpu weekly' do
+      expect(@graphs.cpu_weekly).to eq('//stats.serveriai.lt/graph.php?Ds252x+6Lek1o0SV2+u99fqhNaiflbCcb6QuGzlRJ9yy2R1VycHOc6baz3zRB6Am1RJcniVrpCjj+A47DMwkyfQ==')
+    end
   end
 
   it 'should return server tasks with specified options' do
-    stub_command('server_tasks', { id: 3, count: 1, task_id: 1 })
+    stub_command('server_tasks', id: 3, count: 1, task_id: 1)
       .to_return(json_response('server_tasks.json'))
-    server_tasks = @client.server_tasks(1, { task_id: 1 })
-    expect(server_tasks.first.ta_params.domain).to eq('server.example.com')
+    server_tasks = Ivapi.client.server(3).tasks(1, { task_id: 1 })
+    expect(server_tasks.first.params.domain).to eq('server.example.com')
   end
 
-  it 'should return server graphs' do
-    stub_command('server_graphs', { id: 3, width: 1000, ip: '12.23.34.45' })
-      .to_return(json_response('server_graphs.json'))
-    server_graphs = @client.server_graphs(1000, '12.23.34.45')
-    expect(server_graphs.cpu_weekly).to eq('//stats.serveriai.lt/graph.php?Ds252x+6Lek1o0SV2+u99fqhNaiflbCcb6QuGzlRJ9yy2R1VycHOc6baz3zRB6Am1RJcniVrpCjj+A47DMwkyfQ==')
-  end
+  describe 'server os' do
+    before(:each) do
+      stub_command('server_os', id: 3)
+        .to_return(json_response('server_os.json'))
+      @os = Ivapi.server.os['debian-6.0-x86_64']
+    end
 
-  it 'should return server os' do
-    stub_command('server_os', { id: 3 })
-      .to_return(json_response('server_os.json'))
-    server_os = @client.server_os
-    expect(server_os['debian-6.0-x86_64'].title).to eq('Debian 6')
+    it 'should return cpu weekly' do
+      expect(@os.title).to eq('Debian 6')
+    end
   end
 
-  it 'should reboot server' do
-    stub_command('server_reboot', { id: 3 })
-      .to_return(json_response('server_reboot.json'))
-    server_reboot = @client.server_reboot
-    expect(server_reboot.task_id).to eq('11')
-  end
+  describe 'server reboot' do
+    before(:each) do
+      stub_command('server_reboot', id: 3)
+        .to_return(json_response('server_reboot.json'))
+      @reboot_response = Ivapi.server.reboot
+    end
 
-  it 'should recreate server' do
-    stub_command('server_recreate', { id: 3, os: 'debian-6.0-x86_64' })
-      .to_return(json_response('server_recreate.json'))
-    server_recreate = @client.server_recreate('debian-6.0-x86_64')
-    expect(server_recreate.task_id).to eq('12')
+    it 'should return task id' do
+      expect(@reboot_response.task_id).to eq('11')
+    end
   end
 
-  it 'should reset server password' do
-    stub_command('server_reset_password', { id: 3 })
-      .to_return(json_response('server_reset_password.json'))
-    server_reset_password = @client.server_reset_password
-    expect(server_reset_password.task_id).to eq('13')
+  describe 'server recreate server' do
+    before(:each) do
+      stub_command('server_recreate', id: 3, os: 'debian-6.0-x86_64')
+       .to_return(json_response('server_recreate.json'))
+      @recreate_response = Ivapi.server.recreate('debian-6.0-x86_64')
+    end
+
+    it 'should return task id' do
+      expect(@recreate_response.task_id).to eq('12')
+    end
   end
 
-  it 'should flush server iptables' do
-    stub_command('server_flush_iptables', { id: 3 })
-      .to_return(json_response('server_flush_iptables.json'))
-    server_flush_iptables = @client.server_flush_iptables
-    expect(server_flush_iptables.task_id).to eq('16')
+  describe 'reset server password' do
+    before(:each) do
+      stub_command('server_reset_password', id: 3)
+        .to_return(json_response('server_reset_password.json'))
+      @reset_pwd_response = Ivapi.server.reset_password
+    end
+
+    it 'should return task id' do
+      expect(@reset_pwd_response.task_id).to eq('13')
+    end
   end
 
-  it 'should change server firewall settings' do
-    stub_command('server_firewall', { id: 3 })
-      .to_return(json_response('server_firewall.json'))
-    server_firewall = @client.server_firewall
-    expect(server_firewall.pps).to eq('1000')
+  describe 'flush server iptables' do
+    before(:each) do
+      stub_command('server_flush_iptables', id: 3)
+        .to_return(json_response('server_flush_iptables.json'))
+      @flush_response = Ivapi.server.flush_iptables
+    end
+
+    it 'should return task id' do
+      expect(@flush_response.task_id).to eq('16')
+    end
   end
 
-  it 'should change server plan' do
-    stub_command('server_change', { id: 3 })
-      .to_return(json_response('server_change.json'))
-    server_change = @client.server_change
-    expect(server_change.task_id).to eq('14')
+  describe 'change server firewall settings' do
+    before(:each) do
+      stub_command('server_firewall', id: 3)
+        .to_return(json_response('server_firewall.json'))
+      @firewall = Ivapi.server.firewall
+    end
+
+    it 'should return correct pps' do
+      expect(@firewall.pps).to eq('1000')
+    end
   end
 
-  it 'should change server hostname' do
-    stub_command('server_domain', { id: 3, domain: 'example.com' })
-      .to_return(json_response('server_domain.json'))
-    server_domain = @client.server_domain('example.com')
-    expect(server_domain.task_id).to eq('15')
+  describe 'change server plan' do
+    before(:each) do
+      stub_command('server_change', id: 3)
+        .to_return(json_response('server_change.json'))
+      @plan_response = Ivapi.server.change
+    end
+
+    it 'should return correct pps' do
+      expect(@plan_response.task_id).to eq('14')
+    end
   end
 
+  describe 'change server hostname' do
+    before(:each) do
+      stub_command('server_domain', id: 3, domain: 'example.com')
+        .to_return(json_response('server_domain.json'))
+      @hostname_response = Ivapi.server.domain('example.com')
+    end
+
+    it 'should return task id' do
+      expect(@hostname_response.task_id).to eq('15')
+    end
+
+    it 'should response with alias method' do
+      expect(Ivapi.server.hostname('example.com').task_id).to eq('15')
+    end
+  end
 end