skype_check 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa5c71dec33830855f7aecfa648b934313926fde
+  data.tar.gz: d030748ecf22b21b05857c38b5e8f9df85ed1118
+SHA512:
+  metadata.gz: 62fba4b969c1330973962de8b22daa9f9b39c91e97ebaf0885ec7cce0dac665ac0d550bf8d01d76b6947df3bc76853d8b981e9c472c8d7a360f078737c0113f9
+  data.tar.gz: da710fbb5fe34c5c5b0db7888f05b754b7a0471fa0fe5a6ad1db2236f2d8c0be12fb25ff4d7d4d37f936e7b653dae8f88f8f2c5d67d8cd45014931ca4ef6ce15

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+GuardFile
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in skype_check.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    skype_check (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    coderay (1.0.9)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    formatador (0.2.4)
+    guard (1.7.0)
+      formatador (>= 0.2.4)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (2.5.4)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    listen (0.7.3)
+    lumberjack (1.0.3)
+    method_source (0.8.1)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rb-fsevent (0.9.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.5)
+    safe_yaml (1.0.4)
+    slop (3.4.5)
+    thor (0.19.1)
+    webmock (1.19.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  guard
+  guard-rspec
+  rake
+  rb-fsevent (~> 0.9)
+  rspec
+  skype_check!
+  webmock

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 smnplk
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Simon Polak
+
+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,52 @@
+# SkypeCheck
+
+This is a small gem for checking skype username availability/existance.
+When (for some reason) you need to check if some skype username exists, this gem 
+should do the job for you.
+
+##Install
+
+gem install skype_check
+
+## Usage
+```ruby
+require 'skype_check'
+
+begin
+  is_taken = SkypeCheck::Username.is_taken?('my_username') 
+  #or
+  is_available = SkypeCheck::Username.is_available?('my_username')
+rescue SkypeCheck::QueryError, SkypeCheck::UsernameValidator => e
+  #handle exception
+  puts e.message
+end
+```
+Requests are made to Skype's username validation endpoint, which points to
+'https://login.skype.com/json/validator' at the time of this writing. 
+
+But should Skype's endpoint change in the future, you set it like this
+
+````ruby
+SkypeCheck.configure { |c| c.username_validator_endpoint = '<new_url>' }
+```
+
+If you want to get back the full json response in a hash
+
+```ruby
+begin
+  response = SkypeCheck::Username.query('my_username')
+rescue SkypeCheck::QueryError, SkypeCheck::UsernameValidator => e
+  #handle exception
+  puts e.message
+end
+```
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/example/demo.rb

@@ -0,0 +1,33 @@
+require_relative '../lib/skype_check'
+
+#Check for username 'smnplk' and get back json response as a Hash
+#This is what you should get 
+#{"status"=>406, "status_text"=>"valid", "data"=>{"markup"=>"Skype Name not available", "alternatives"=>true,
+#"fieldDetails"=>"<label>Suggestions</label><ul><li><label><input class=\"skypeNameSuggestion\" 
+#type=\"radio\" name=\"selectSkypeName\" value=\"smnplk1\"/>smnplk1</label> 
+#</li><li><label><input class=\"skypeNameSuggestion\" type=\"radio\" 
+#name=\"selectSkypeName\" value=\"smnplk2\"/>smnplk2</label> 
+#</li><li><label><input class=\"skypeNameSuggestion\" type=\"radio\" name=\"selectSkypeName\" value=\"smnplk55\"/>smnplk55</label> </li></ul>"}}
+begin 
+  response = SkypeCheck::Username.query('smnplk')
+  puts response
+rescue SkypeCheck::QueryError, SkypeCheck::UsernameValidationError => e
+  puts e.message
+end
+
+
+begin
+  #Check if skype username is taken (meaning user exists)
+  user_1 = 'smnplk'
+  bool = SkypeCheck::Username.is_taken?(user_1)
+  puts "Username #{user_1} is #{bool ? 'taken': 'not taken'}."
+
+  #Check if skype username is available (no user with that name exists)
+  user_2 = 'double0071ui'
+  bool2 = SkypeCheck::Username.is_available?(user_2)
+  puts "Username #{user_2} is #{bool ? 'available': 'not available'}."
+
+
+rescue SkypeCheck::QueryError, SkypeCheck::UsernameValidationError => e
+  puts e.message
+ end

data/lib/skype_check.rb

@@ -0,0 +1,4 @@
+require_relative "skype_check/version"
+require_relative "skype_check/config"
+require_relative "skype_check/username"
+

data/lib/skype_check/config.rb

@@ -0,0 +1,28 @@
+module SkypeCheck
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration || configure
+    end
+  
+    def configure
+      @configuration = Configuration.new
+      yield(configuration) if block_given?
+      @configuration
+    end
+  end
+
+
+  class Configuration
+    attr_accessor :username_validator_endpoint
+
+    DEFAULT_ENDPOINT = 'https://login.skype.com/json/validator'
+ 
+
+    def username_validator_endpoint
+      @username_validator_endpoint || DEFAULT_ENDPOINT
+    end
+    
+  end
+end

data/lib/skype_check/http_service.rb

@@ -0,0 +1,34 @@
+require 'net/http'
+require 'openssl'
+require_relative 'config'
+require_relative 'query_error'
+
+module SkypeCheck
+
+  module HTTPService
+
+    def http_query(username) 
+      begin
+        #setup uri object with username param
+        uri = URI(SkypeCheck.configuration.username_validator_endpoint)
+        param = { new_username: username }
+        uri.query = URI.encode_www_form(param)
+
+        #build a request object
+        http = Net::HTTP.new(uri.host, uri.port)
+        if uri.kind_of? URI::HTTPS
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+
+        request = Net::HTTP::Get.new(uri.request_uri)
+        http.request(request)
+      rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError, SocketError => e
+        raise SkypeCheck::QueryError.new(e)
+      end
+    end
+
+    module_function :http_query
+
+  end
+end

data/lib/skype_check/query_error.rb

@@ -0,0 +1,14 @@
+module SkypeCheck
+  #wrapper around all possible network and other io exceptions
+  class QueryError < StandardError
+    attr_reader :source_error, :message
+
+    def initialize(source_error)
+      @source_error = source_error
+    end
+
+    def message
+      "SkypeCheck: Source error type: #{@source_error.class}, source error message: #{@source_error.message}"
+    end
+  end
+end

data/lib/skype_check/username.rb

@@ -0,0 +1,33 @@
+require_relative 'config'
+require_relative 'http_service'
+require_relative 'username_validation_error'
+require 'json'
+
+module SkypeCheck
+  class Username
+  
+    class << self
+
+      def query(username)
+        raise SkypeCheck::UsernameValidationError, "Input username is nil!" if username.nil?
+        raise SkypeCheck::UsernameValidationError, "Input username is too long!" if username.size > 32
+        raise SkypeCheck::UsernameValidationError, "Input username is too short!" if username.size < 6
+        raise SkypeCheck::UsernameValidationError, "Input username should not start with a number!" if username.match(/\A\d/)
+
+        resp_body = SkypeCheck::HTTPService.http_query(username).body
+        JSON.parse(resp_body)
+      end
+
+      def is_taken?(username)
+        query(username)["status"] == 406 
+      end
+
+      #when it comes to web services it's better to be explicit with semantic meanings of http return codes, it's better than calling !is_taken?(username) here.
+      def is_available?(username)
+        query(username)["status"] == 200
+      end
+
+    end
+
+  end
+end

data/lib/skype_check/username_validation_error.rb

@@ -0,0 +1,4 @@
+module SkypeCheck
+  #Skype usernames must be less than 33 chars long and must not start with a number
+  class UsernameValidationError < ArgumentError; end
+end

data/lib/skype_check/version.rb

@@ -0,0 +1,3 @@
+module SkypeCheck
+  VERSION = "0.0.2"
+end

data/skype_check.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'skype_check/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "skype_check"
+  spec.version       = SkypeCheck::VERSION
+  spec.authors       = ["Simon Polak"]
+  spec.email         = ["smnplk@gmail.com"]
+  spec.description   = %q{Tool for checking skype username availability}
+  spec.summary       = %q{Check if skype username exists or is available}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+	spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rb-fsevent", "~> 0.9"
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,25 @@
+require_relative '../spec_helper'
+describe SkypeCheck do
+  #cleanup
+  after(:all) { SkypeCheck.configure { |c| c.username_validator_endpoint = SkypeCheck::Configuration::DEFAULT_ENDPOINT } }
+
+  describe "Configuration" do
+
+    context "Default configuration" do
+      it "returns  a Configuration object with default settings" do
+        expect(SkypeCheck.configuration.class.name).to eq("SkypeCheck::Configuration")
+        expect(SkypeCheck.configuration.username_validator_endpoint).to eq('https://login.skype.com/json/validator')
+      end
+    end
+
+    context "Manual configuration with a block" do
+      it "should override default or previous settings" do
+        SkypeCheck.configure do |c|
+          c.username_validator_endpoint = 'new_url'
+        end
+
+        expect(SkypeCheck.configuration.username_validator_endpoint).to eq('new_url')
+      end 
+    end
+  end
+end 

data/spec/lib/username_spec.rb

@@ -0,0 +1,66 @@
+require_relative '../spec_helper'
+describe SkypeCheck::Username do
+
+  let(:query_url) { "#{SkypeCheck.configuration.username_validator_endpoint}?new_username=username" }
+  let(:successfull_response) { '{"status": 200}' }
+  let(:taken_response) { '{"status":406, "data": {"markup":"Skype Name not available", "alternatives":true}}' }
+  let(:available_response) { '{"status":200}' }
+
+  let(:too_long_username) { (0..32).map {"a"}.join }
+  let(:too_short_username) { 'abcde' }
+
+  describe ".query" do
+    context "when  successfull" do
+      it  "should return a parsed json response as Hash" do
+        stub_request(:get, query_url).to_return(status: 200, body: successfull_response, headers: {})
+
+        expect(SkypeCheck::Username.query('username').class).to eq(Hash)
+      end
+    end
+
+    context "when connection error" do 
+      it "can raise SocketError" do
+        SkypeCheck::Username.should_receive(:query).with('username').and_raise(SocketError)
+        lambda { SkypeCheck::Username.query('username')}.should raise_error(SocketError)
+      end
+    end
+
+    context "when username is not valid" do
+      it "should raise UsernameValidationError with username that is longer than 32 chars" do
+        expect{ SkypeCheck::Username.query(too_long_username) }.to raise_error(SkypeCheck::UsernameValidationError, "Input username is too long!")
+      end
+
+      it "should raise UsernameValidationError with username that is shorter than 6 chars" do
+        expect{ SkypeCheck::Username.query(too_short_username) }.to raise_error(SkypeCheck::UsernameValidationError, "Input username is too short!")
+      end
+
+      it "should raise UsernameValidationError with username that begins with a number" do
+        expect{ SkypeCheck::Username.query('1_username') }.to raise_error(SkypeCheck::UsernameValidationError, "Input username should not start with a number!")
+      end
+
+
+      it "should raise UsernameValidationError when username is nil" do
+        expect{ SkypeCheck::Username.query(nil) }.to raise_error(SkypeCheck::UsernameValidationError, "Input username is nil!")
+      end
+
+    end
+  end
+
+  describe ".is_taken?" do
+    it "should return true if username is already taken" do
+      stub_request(:get, query_url).to_return(status: 200, body: taken_response, headers: {})
+
+      expect(SkypeCheck::Username.is_taken?('username')).to eq(true)
+    end
+  end
+
+  describe ".is_available?" do
+    it "should return true if username is available" do
+      stub_request(:get, query_url).
+        to_return(status: 200, body: available_response, headers: {})
+
+      expect(SkypeCheck::Username.is_available?('username')).to eq(true)
+    end
+  end
+      
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'rspec/core'
+require 'rspec/expectations'
+require 'rspec/mocks'
+require 'webmock/rspec'
+WebMock.disable_net_connect!(allow_localhost: true)
+require_relative '../lib/skype_check.rb'
+
+

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: skype_check
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Simon Polak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Tool for checking skype username availability
+email:
+- smnplk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/demo.rb
+- lib/skype_check.rb
+- lib/skype_check/config.rb
+- lib/skype_check/http_service.rb
+- lib/skype_check/query_error.rb
+- lib/skype_check/username.rb
+- lib/skype_check/username_validation_error.rb
+- lib/skype_check/version.rb
+- skype_check.gemspec
+- spec/lib/config_spec.rb
+- spec/lib/username_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Check if skype username exists or is available
+test_files:
+- spec/lib/config_spec.rb
+- spec/lib/username_spec.rb
+- spec/spec_helper.rb