proteus_client 0.0.1 → 0.0.2

data/lib/proteus_client/config.rb

@@ -0,0 +1,12 @@
+module ProteusClient
+
+  # Used to configure default values used for creating a ProteusClient::Proxy
+  # @example Configuring values
+  #   ProteusClient.config.domain = "http://localhost:9292"
+  #   ProteusClient.config.api_key= "api_key"
+  #
+  class Config
+    attr_accessor :domain, :api_key
+  end
+
+end

data/lib/{proteus/client.rb → proteus_client/proxy.rb}

@@ -1,5 +1,21 @@
-module Proteus
-  class Client
+module ProteusClient
+
+  # Provides an interface for Proteus REST service to encode videos
+  # @example Creating a new proxy
+  #   ProteusClient::Proxy.new
+  #   ProteusClient::Proxy.new({api_key: "api_key", domain: "http://localhost:9292"})
+  #
+  # @example Testing service
+  #   proteus_client.test_api #=> {message: 'Welcome to Proteus'}
+  #
+  # @example Calling a method
+  #   proteus_client.create_video("video_id","type")
+  #
+  # @raise [APIKeyNotDefined] if api_key is not defined in ProteusClient.config or sent as param
+  # @raise [DomainNotDefined] if domain is not defined in ProteusClient.config or sent as param
+  # @raise [RestClient::Exception] if status code returned from services is not in 200..207
+  #
+  class Proxy
 
     def initialize(options = {})
       options   = merge_with_default_options(options)
@@ -7,10 +23,6 @@ module Proteus
       @domain   = RestClient::Resource.new(options[:domain])
     end
 
-    def self.config
-      @config ||= Proteus::Config.new
-    end
-
     def test_api
       response = submit_request(:get,'/',{})
 
@@ -59,12 +71,12 @@ module Proteus
 
     def merge_with_default_options(options)
       opts = {
-          api_key: Client.config.api_key,
-          domain: Client.config.domain
+          api_key: ProteusClient.config.api_key,
+          domain: ProteusClient.config.domain
       }.merge(options)
 
-      raise "An API key has not been defined" unless opts[:api_key]
-      raise "A domain has not been defined" unless opts[:domain]
+      raise "APIKeyNotDefined" unless opts[:api_key]
+      raise "DomainNotDefined" unless opts[:domain]
 
       opts
     end

data/lib/proteus_client.rb

@@ -1,5 +1,15 @@
 require 'json'
 require 'rest_client'
 
-require_relative 'proteus/config'
-require_relative 'proteus/client'
+require_relative 'proteus_client/config'
+require_relative 'proteus_client/proxy'
+
+# Provides an interface to use Proteus rest services features
+#
+module ProteusClient
+
+  def self.config
+    @config ||= ProteusClient::Config.new
+  end
+
+end

data/spec/proteus_client_spec.rb

@@ -0,0 +1,217 @@
+require 'spec_helper'
+require 'stubs'
+
+require_relative '../lib/proteus_client'
+
+describe ProteusClient::Proxy do
+
+  let(:api_key) { "api_key" }
+
+  let(:proteus_client_wrong_api) do
+    described_class.new(domain: 'http://localhost:9292', api_key: 'wrong_api')
+  end
+
+  let(:proteus_client) do
+    ProteusClient.config.domain   = 'http://localhost:9292'
+    ProteusClient.config.api_key  = 'api_key'
+    described_class.new()
+  end
+
+  it "creates a new instance of proteus with correct api_key" do
+    proteus_client
+    ProteusClient.config.api_key.should == api_key
+  end
+
+  context 'call to test_api' do
+    before(:all) do
+      stub_response(:get,'/',200,'Welcome to proteus',{})
+      @response = proteus_client.test_api
+    end
+
+    it "returns correct message" do
+      @response[:message].should == 'Welcome to proteus'
+    end
+
+  end
+
+  context 'call to create_video_allocation'do
+
+    context 'with no count argument' do
+
+      before(:all) do
+        stub_create_video_allocation
+        @response = proteus_client.create_video_allocation()
+      end
+
+      it "returns a hash" do
+        @response.class.should == Hash
+      end
+
+      it "returns video_allocation_id" do
+        @response[:video_allocation_id].should == '4fe0f752831a9d08bb000010'
+      end
+
+      it "returns urls" do
+        @response[:urls][0].should == {type: 'direct', url:'direct/4fe0f752831a9d08bb000010.flv'}
+        @response[:urls][1].should == {type: 'stream', url:'stream/4fe0f752831a9d08bb000010.flv'}
+        @response[:urls][2].should == {type: 'upload', url:'upload/4fe0f752831a9d08bb000010.flv'}
+      end
+
+    end
+
+    context 'with count argument' do
+
+      before(:all) do
+        stub_create_video_allocations
+        @response = proteus_client.create_video_allocation(2)
+      end
+
+      it "returns an array with two hashes" do
+        @response.class.should == Array
+        @response.size.should == 2
+        @response[0].class.should == Hash
+      end
+
+    end
+
+  end
+
+  context 'call to create_video'do
+
+      before(:all) do
+        stub_create_video
+        @response = proteus_client.create_video('4fe0f752831a9d08bb000010','direct')
+      end
+
+      it "returns a hash" do
+        @response.class.should == Hash
+      end
+
+      it "returns video url" do
+        @response[:url].should == 'direct/4fe0f752831a9d08bb000010.flv'
+      end
+
+  end
+
+  context 'call to create_video_versions'do
+
+    context 'with valid id' do
+
+      before(:all) do
+        stub_response(:post,'/videos/4fe0f752831a9d08bb000010/versions',
+                      200,'',{})
+        @response = proteus_client.create_video_versions('4fe0f752831a9d08bb000010')
+      end
+
+      it "returns success message" do
+        @response[:message].should == 'success'
+      end
+
+    end
+
+    context 'with valid id and type' do
+
+      before(:all) do
+        stub_response(:post,'/videos/4fe0f752831a9d08bb000010/versions',
+                      200,'',{version_settings: 'mobile'})
+        @response = proteus_client.create_video_versions('4fe0f752831a9d08bb000010','mobile')
+      end
+
+      it "returns true" do
+        @response[:message].should == 'success'
+      end
+
+    end
+
+  end
+
+  context 'call to get_video'do
+
+    before(:all) do
+      stub_get_video
+      @response = proteus_client.get_video('4fe0f752831a9d08bb000010')
+    end
+
+    it "returns a hash" do
+      @response.class.should == Hash
+    end
+
+    it "returns video with correct format" do
+      @response['url'].class.should == String
+      @response['duration'].class.should == Fixnum
+      @response['versions'].class.should == Array
+      @response['versions'][0].class.should == Hash
+    end
+
+  end
+
+  context 'call to get_videos' do
+
+    before(:all) do
+      stub_get_videos
+      @response = proteus_client.get_videos('4fe0f752831a9d08bb000010','4fe0f752831a9d08bb000010')
+    end
+
+    it "returns an array with hashes" do
+      @response.class.should == Array
+      @response.size.should  == 2
+      @response.first.class.should == Hash
+    end
+
+    it "returns videos with correct format" do
+      video = @response.first
+      video['url'].class.should == String
+      video['duration'].class.should == Fixnum
+      video['versions'].class.should == Array
+      video['versions'][0].class.should == Hash
+    end
+
+  end
+
+  context 'call to get_video_allocation' do
+
+    context 'with valid arguments' do
+
+      before(:all) do
+        stub_get_video_allocation
+        @response = proteus_client.get_video_allocation('4fe0f752831a9d08bb000010')
+      end
+
+      it "returns a hash" do
+        @response.class.should == Hash
+      end
+
+      it "returns video with correct format" do
+        @response['url_direct'].class.should == String
+        @response['url_stream'].class.should == String
+        @response['url_upload'].class.should == String
+      end
+
+    end
+
+  end
+
+  context 'submit request' do
+
+    it 'call with :get works returns a correct response' do
+      stub_resource(:get)
+      proteus_client.send(:submit_request,:get,'/',{}).class.should == String
+    end
+
+    it 'call with :post works returns a correct response' do
+      stub_resource(:post)
+      proteus_client.send(:submit_request,:post,'/',{}).class.should == String
+    end
+
+    it 'call with :get works returns a correct response' do
+      stub_resource(:get)
+      proteus_client.send(:submit_request,:get_raw,'/',{}).class.should == String
+    end
+
+    it 'call with not defined method works raises exception' do
+      lambda { proteus_client.send(:submit_request,:put,'/',{}) }.should raise_error
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: proteus_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -18,8 +18,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/proteus_client.rb
-- lib/proteus/config.rb
-- lib/proteus/client.rb
+- lib/proteus_client/config.rb
+- lib/proteus_client/proxy.rb
+- spec/proteus_client_spec.rb
 homepage: https://github.com/solojavier/proteus_client
 licenses: []
 post_install_message: 
@@ -44,5 +45,6 @@ rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Ruby client to use proteus rest service
-test_files: []
+test_files:
+- spec/proteus_client_spec.rb
 has_rdoc: 

data/lib/proteus/config.rb

@@ -1,5 +0,0 @@
-module Proteus
-  class Config
-    attr_accessor :domain, :api_key
-  end
-end