luminati 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9adc62b4fd44c0b0e920daf365d0ccc4af9388b8
-  data.tar.gz: cf70c9548e92575255cd5df94710e7cd8998fee7
+  metadata.gz: 100e95b81f766c176f4fb8f97a4a78209728dbfa
+  data.tar.gz: c25c2f7b7da62d1d42eef95b72de8898a1494979
 SHA512:
-  metadata.gz: efebc81f6a72f0ca7cb1cd43121c9aaa21c9148b4554e61bc1ec96856ed742d7a6fca96c0491acc44f63dc6e301c6406493a0a6295b77f3c1b88f05aa197c463
-  data.tar.gz: 757cc46a7f860a163ec39e53cd93167cac9e077c37818d91fd76cbb2777f39e0e72be55f84aba56dc92c0436334921d33b3a688af238d24fd21af1088b58958d
+  metadata.gz: d5a57daf74528372c6ce2775dbce85db255f1b1efc170ff3d36e53b22686d46c675e6c9552eaca1eb6b8b5938830cd7a72a35bb6abf7aa41aa75b6e19daa1233
+  data.tar.gz: 458abb9ce704f54f54a4add49152cff7da717937143698a933b68e2a5f7570cff58cf9ede60f47edebfe8fcd734c0e6354ec72023e41f66f96abd0551a6326a2

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    Luminati (0.0.1)
+    luminati (0.0.3)
       faraday (>= 0.9)
+      faraday_middleware (>= 0.9)
 
 GEM
   remote: http://rubygems.org/
@@ -10,6 +11,8 @@ GEM
     diff-lcs (1.2.5)
     faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
     metaclass (0.0.4)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
@@ -19,21 +22,21 @@ GEM
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)
       rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.0)
+    rspec-core (3.2.2)
       rspec-support (~> 3.2.0)
     rspec-expectations (3.2.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.0)
+    rspec-mocks (3.2.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
-    rspec-support (3.2.1)
+    rspec-support (3.2.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  Luminati!
+  luminati!
   mocha
   rake
   rspec

data/README.md

@@ -1,5 +1,37 @@
 # Luminati
 Ruby-wrapper for communicating with the Luminati.io-network.
 
+## How to use the wrapper
+Add it to your Gemfile:
+```ruby
+gem 'luminati'
+```
+
+Basic example:
+```ruby
+luminati        =   Luminati::Client.new('username', 'password', zone: 'gen', port: 22225)
+connection      =   luminati.get_connection(country: nil, dns_resolution: nil, session: nil)
+
+session_id      =   connection[:session_id]
+proxy_user      =   connection[:username]
+proxy_password  =   connection[:password]
+proxy_ip        =   connection[:ip_address]
+proxy_port      =   connection[:port]
+```
+
+Use a custom zone, only use american ips and resolve dns remotely (on the client nodes):
+```ruby
+luminati        =   Luminati::Client.new('username', 'password', zone: 'customzone', port: 22225)
+connection      =   luminati.get_connection(country: 'us', dns_resolution: :remote, session: nil)
+```
+
+Specify a session to re-use a previously used ip-address:
+```ruby
+luminati        =   Luminati::Client.new('username', 'password', zone: 'gen', port: 22225)
+connection      =   luminati.get_connection(country: 'us', dns_resolution: :remote, session: '4b21543118c63c5a98397c240bee05ae18d0509d')
+```
+
 ## Test coverage
-Currently missing, will be added later.
+Initial test coverage has since 2015-03-20 been added.
+
+More tests will be added continously.

data/lib/luminati.rb

@@ -1,5 +1,5 @@
 module Luminati
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
   
   require File.join(File.dirname(__FILE__), 'luminati/errors')
   require File.join(File.dirname(__FILE__), 'luminati/client')

data/lib/luminati/client.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require 'faraday_middleware'
 
 module Luminati
   class Client
@@ -16,7 +17,8 @@ module Luminati
       }
       
       self.regexes    =   {
-        failed_auth: /failed\sauth/i
+        failed_auth:    /failed\sauth/i,
+        invalid_params: /invalid\sparams/i
       }
     end
     
@@ -86,8 +88,9 @@ module Luminati
     end
     
     def check_response_for_errors(response)
-      if (response && response.is_a?(String) && response.present?)
+      if (response && response.is_a?(String) && !response.empty?)
         raise Luminati::FailedAuthError, "Failed to authenticate your account with Luminati.io. Please check your credentials or the contract for your account." if response =~ self.regexes[:failed_auth]
+        raise Luminati::InvalidParamsError, "Failed to perform your requested action since invalid parameters were supplied." if response =~ self.regexes[:invalid_params]
       end
     end
     

data/lib/luminati/errors.rb

@@ -1,3 +1,4 @@
 module Luminati
   class FailedAuthError < StandardError; end
+  class InvalidParamsError < StandardError; end
 end

data/luminati.gemspec

@@ -3,7 +3,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 1.3.5") if s.respond_to? :required_rubygems_version=
 
   s.name = 'luminati'
-  s.version = '0.0.2'
+  s.version = '0.0.3'
 
   s.homepage      =   "https://github.com/Agiley/Luminati"
   s.email         =   "sebastian@agiley.se"
@@ -12,6 +12,7 @@ Gem::Specification.new do |s|
   s.summary       =   "Ruby-wrapper for communicating with the Luminati.io-network."
 
   s.add_dependency "faraday",             ">= 0.9"
+  s.add_dependency "faraday_middleware",  ">= 0.9"
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
@@ -28,6 +29,7 @@ Gem::Specification.new do |s|
  lib/luminati/client.rb
  lib/luminati/errors.rb
  luminati.gemspec
+ spec/luminati/client_spec.rb
  spec/spec_helper.rb
  ]
  # = MANIFEST =

data/spec/luminati/client_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe "Luminati::Client"  do
+  
+  context "initialization" do    
+    it "should set the correct instance variables for a new client with default initialization settings" do
+      username  =   'user'
+      password  =   'password'
+      client    =   Luminati::Client.new(username, password)
+      
+      expect(client.username).to be == username
+      expect(client.password).to be == password
+      expect(client.zone).to be == :gen
+      expect(client.port).to be == 22225
+    end
+    
+    it "should set the correct instance variables for a new client with custom initialization settings" do
+      username  =   'user'
+      password  =   'password'
+      client    =   Luminati::Client.new(username, password, zone: :custom, port: 12345)
+      
+      expect(client.username).to be == username
+      expect(client.password).to be == password
+      expect(client.zone).to be == :custom
+      expect(client.port).to be == 12345
+    end
+  end
+  
+  context "master proxy" do
+    it "should be able to fetch a master proxy with correct credentials" do
+      client    =   Luminati::Client.new(CREDENTIALS['username'], CREDENTIALS['password'])
+      proxy     =   client.fetch_master_proxy
+      
+      expect(proxy).not_to be_nil
+      expect(proxy).not_to be_empty
+      expect(proxy).to match(Resolv::IPv4::Regex)
+    end
+    
+    it "should not be able to fetch a master proxy with incorrect credentials" do
+      client    =   Luminati::Client.new('user', 'password')
+      expect{client.fetch_master_proxy}.to raise_error(Luminati::InvalidParamsError)
+    end
+  end
+  
+  context "connection" do
+    it "should successfully be able to retrieve a valid connection with correct credentials" do
+      client      =   Luminati::Client.new(CREDENTIALS['username'], CREDENTIALS['password'])
+      connection  =   client.get_connection
+      
+      expect(connection).not_to be_nil
+      expect(connection).not_to be_empty
+      expect(connection[:ip_address]).to match(Resolv::IPv4::Regex)
+      expect(connection[:port]).to be == 22225
+    end
+    
+    it "should not be able to retrieve a valid connection with incorrect credentials" do
+      client    =   Luminati::Client.new('user', 'password')
+      expect{client.get_connection}.to raise_error(Luminati::InvalidParamsError)
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -23,4 +23,6 @@ require File.expand_path('../../lib/luminati', __FILE__)
 
 RSpec.configure do |config|
   config.mock_with :mocha
-end
+end
+
+CREDENTIALS = YAML.load_file(File.join(File.dirname(__FILE__), "/support/credentials.yml"))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luminati
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sebastian Johnsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-16 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +95,7 @@ files:
 - lib/luminati/client.rb
 - lib/luminati/errors.rb
 - luminati.gemspec
+- spec/luminati/client_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Agiley/Luminati
 licenses: []
@@ -106,4 +121,5 @@ signing_key:
 specification_version: 2
 summary: Ruby-wrapper for communicating with the Luminati.io-network.
 test_files:
+- spec/luminati/client_spec.rb
 - spec/spec_helper.rb