loopiator 0.1.0

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+group :development, :test do
+  gem 'rspec'
+  gem "mocha"
+end
+
+gemspec
+

data/README.md

@@ -0,0 +1,4 @@
+Loopiator
+=========
+
+Ruby Gem for Interacting with Loopia's API

data/Rakefile

@@ -0,0 +1,87 @@
+## helper functions
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+begin
+  # Rspec 2.0
+  require 'rspec/core/rake_task'
+
+  desc 'Default: run specs'
+  task :default => :spec
+  RSpec::Core::RakeTask.new do |t|
+    t.pattern = "spec/**/*_spec.rb"
+  end
+
+  RSpec::Core::RakeTask.new('rcov') do |t|
+    t.pattern = "spec/**/*_spec.rb"
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec']
+  end
+
+rescue LoadError
+  puts "Rspec not available. Install it with: gem install rspec"
+end
+
+## release management tasks
+
+desc "Commit, create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{gem_file}"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split(" # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| " #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = " s.files = %w[\n#{files}\n ]\n"
+  spec = [head, manifest, tail].join(" # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+

data/lib/generators/loopiator/loopiator_generator.rb

@@ -0,0 +1,18 @@
+require 'generators/helpers/file_helper'
+
+module Loopiator
+  module Generators
+    class LoopiatorGenerator < Rails::Generators::Base
+      namespace "loopiator"
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Copies loopia.yml to the Rails app's config directory."
+
+      def copy_config
+        template "loopia.template.yml", "config/loopia.yml"
+      end
+
+    end
+  end
+end
+

data/lib/generators/templates/loopia.template.yml

@@ -0,0 +1,16 @@
+---
+development:
+  username: "your-username"
+  password: "your-password"
+  endpoint: "https://api.loopia.se/RPCSERV"
+
+test:
+  username: "your-username"
+  password: "your-password"
+  endpoint: "https://api.loopia.se/RPCSERV"
+
+production:
+  username: "your-username"
+  password: "your-password"
+  endpoint: "https://api.loopia.se/RPCSERV"
+

data/lib/loopiator/client.rb

@@ -0,0 +1,79 @@
+require 'uri'
+require 'cgi'
+require 'rubygems'
+require 'xmlrpc/client'
+require 'simpleidn'
+
+module Loopiator
+  class Client
+    attr_accessor :config, :client, :username, :password, :endpoint
+    
+    include Loopiator::Logger
+    
+  	def initialize(options = {})
+  		@config       =   set_config
+      
+      options.symbolize_keys!
+      @config.merge!(options)
+      
+  		@username     =   @config.fetch(:username, nil)
+  		@password     =   @config.fetch(:password, nil)
+  		@endpoint     =   @config.fetch(:endpoint, nil)
+  		
+  		timeout       =   options.fetch(:timeout, 500)
+  		
+  		set_client(timeout)
+  	end
+
+  	def set_config
+  	  rails_env     =   defined?(Rails) ? Rails.env : "development"
+  	  config      ||=   YAML.load_file(File.join(Rails.root, "config/loopia.yml"))[rails_env] if defined?(Rails)
+      config      ||=   YAML.load_file(File.join(File.dirname(__FILE__), "../generators/templates/loopia.yml"))[rails_env] rescue nil
+      config      ||=   YAML.load_file(File.join(File.dirname(__FILE__), "../generators/templates/loopia.template.yml"))[rails_env] rescue nil
+      config      ||=   {}
+      
+      config.symbolize_keys!
+      
+      return config
+  	end
+  	
+  	def set_client(timeout = 500)
+  	  @client = XMLRPC::Client.new_from_uri(@endpoint)
+  	  @client.instance_variable_get(:@http).instance_variable_set(:@verify_mode, OpenSSL::SSL::VERIFY_NONE)
+  	  @client.timeout = timeout
+  	  @client
+  	end
+  	
+  	def call(rpc_method, *args)
+  	  response    =   ""
+  	  
+  	  begin
+        response  =   @client.call(rpc_method, @username, @password, *args)
+        
+      rescue EOFError => eof_error
+        raise Loopiator::ConnectionError
+      end
+      
+      return response
+  	end
+  	
+  	def parse_status_response(response)
+  	  response  =   response.downcase.to_sym
+  	  
+  	  case response
+        when :ok                then  return response
+        when :domain_occupied   then  return response
+        when :auth_error        then  raise Loopiator::AuthError
+        when :rate_limited      then  raise Loopiator::RateLimitError
+        when :bad_indata        then  raise Loopiator::InvalidParameterError
+        when :unknown_error     then  raise Loopiator::UnknownError
+        else
+          return response
+      end
+  	end
+
+  	include Loopiator::Domains
+  	include Loopiator::Credits
+  end
+end
+

data/lib/loopiator/credits.rb

@@ -0,0 +1,15 @@
+module Loopiator
+  module Credits
+    
+    # https://www.loopia.se/api/getcreditsamount/
+    def get_credits_amount(with_vat = true, customer_number = "")      
+      call("getCreditsAmount", customer_number, with_vat).to_f
+    end
+    
+    # https://www.loopia.se/api/payinvoiceusingcredits/
+    def pay_invoice_using_credits(reference_number, customer_number = "")      
+      parse_status_response(call("payInvoiceUsingCredits", customer_number, reference_number.to_s))
+    end
+    
+  end
+end

data/lib/loopiator/domains.rb

@@ -0,0 +1,47 @@
+module Loopiator
+  module Domains
+    
+    def domain_is_free(domain_name)
+      response      =   parse_status_response(call("domainIsFree", encode_domain(domain_name)))
+      
+      return response.eql?(:ok)
+    end
+    
+    def get_domain(domain_name, customer_number = "")
+      domain        =   nil
+      response      =   call("getDomain", customer_number, encode_domain(domain_name))
+      
+      if (response && response.is_a?(Hash))
+        domain      =   Loopiator::Models::Domain.new(response)
+      end
+      
+      return domain
+    end
+    
+    def add_domain_to_account(domain_name, should_buy = false, customer_number = "")
+      response      =   parse_status_response(call("addDomainToAccount", customer_number, encode_domain(domain_name), should_buy))
+      
+      return response.eql?(:ok)
+    end
+    
+    def purchase_domain(domain_name, customer_number = "")
+      success = false
+      
+      if (add_domain_to_account(domain_name, true, customer_number))
+        domain = get_domain(domain_name, customer_number)
+        
+        if (domain && domain.needs_to_be_paid? && domain.reference_number != nil && domain.reference_number != "")
+          success = pay_invoice_using_credits(domain.reference_number, customer_number)
+        end
+      end
+      
+      return success
+    end
+    
+    private
+    def encode_domain(domain_name)
+      SimpleIDN.to_ascii(domain_name)
+    end
+    
+  end
+end

data/lib/loopiator/errors.rb

@@ -0,0 +1,33 @@
+module Loopiator
+  class ApiError < StandardError; end
+  
+  class AuthError < ApiError
+    def message
+      "You've supplied invalid authentication credentials. Please check your credentials and then try again."
+    end
+  end
+  
+  class RateLimitError < ApiError
+    def message
+      "You've reached the number of allowed API-requests within the given time period. Please wait a bit and then try again."
+    end
+  end
+  
+  class InvalidParameterError < ApiError
+    def message
+      "One or several parameters have invalid parameters supplied."
+    end
+  end
+  
+  class UnknownError < ApiError
+    def message
+      "An unknown error occurred while trying to request data from the API."
+    end
+  end
+  
+  class ConnectionError < ApiError
+    def message
+      "An unknown connection error occurred while trying to connect to the API."
+    end
+  end
+end

data/lib/loopiator/extensions/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+end
+

data/lib/loopiator/logger.rb

@@ -0,0 +1,9 @@
+module Loopiator
+  module Logger
+    
+    def log(level, message)
+      (defined?(Rails) && Rails.logger) ? Rails.logger.send(level, message) : puts(message)
+    end
+    
+  end
+end

data/lib/loopiator/models/domain.rb

@@ -0,0 +1,34 @@
+module Loopiator
+  module Models
+    
+    class Domain
+      attr_accessor :paid, :unpaid_amount, :registered, :domain, :renewal_status, :expiration_date, :reference_number
+      
+      def initialize(hash)
+        hash.symbolize_keys!
+        
+        self.paid               =   hash.fetch(:paid, 0).eql?(1)
+        self.unpaid_amount      =   hash.fetch(:unpaid_amount, 0)
+        self.registered         =   hash.fetch(:registered, 0).eql?(1)
+        self.domain             =   hash.fetch(:domain, "")
+        self.renewal_status     =   hash.fetch(:renewal_status, "")
+        self.expiration_date    =   hash.fetch(:expiration_date, "")
+        self.reference_number   =   hash.fetch(:reference_no, "").to_s
+      end
+      
+      def paid?
+        paid
+      end
+      
+      def registered?
+        registered
+      end
+      
+      def needs_to_be_paid?
+        (!paid? && unpaid_amount > 0)
+      end
+      
+    end
+    
+  end
+end

data/lib/loopiator/railtie.rb

@@ -0,0 +1,12 @@
+require 'loopiator'
+require 'rails'
+
+module Loopiator
+  class Railtie < Rails::Railtie
+    
+    #rake_tasks do
+    #  Dir[File.join(File.dirname(__FILE__), '../tasks/*.rake')].each { |ext| load ext }
+    #end
+    
+  end
+end

data/lib/loopiator.rb

@@ -0,0 +1,20 @@
+module Loopiator
+  VERSION = "0.1.0"
+
+  require File.join(File.dirname(__FILE__), 'loopiator/railtie') if defined?(Rails)
+  
+  if (!Hash.instance_methods(false).include?(:symbolize_keys!))
+    require File.join(File.dirname(__FILE__), 'loopiator/extensions/hash')
+  end
+
+  require File.join(File.dirname(__FILE__), 'loopiator/logger')
+  require File.join(File.dirname(__FILE__), 'loopiator/errors')
+  
+  require File.join(File.dirname(__FILE__), 'loopiator/models/domain')
+  
+  require File.join(File.dirname(__FILE__), 'loopiator/domains')
+  require File.join(File.dirname(__FILE__), 'loopiator/credits')
+
+  require File.join(File.dirname(__FILE__), 'loopiator/client')
+end
+

data/loopiator.gemspec

@@ -0,0 +1,45 @@
+Gem::Specification.new do |s|
+  s.specification_version     = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.5") if s.respond_to? :required_rubygems_version=
+
+  s.name = 'loopiator'
+  s.version = '0.1.0'
+
+  s.homepage      =   "https://github.com/Agiley/Loopiator"
+  s.email         =   "sebastian@agiley.se"
+  s.authors       =   ["Sebastian Johnsson"]
+  s.description   =   "Interface for communicating with Loopia's API"
+  s.summary       =   "Interface for communicating with Loopia's API"
+
+  s.add_dependency 'simpleidn', '>= 0.0.4'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'mocha'
+
+  # = MANIFEST =
+ s.files = %w[
+ Gemfile
+ README.md
+ Rakefile
+ lib/generators/loopiator/loopiator_generator.rb
+ lib/generators/templates/loopia.template.yml
+ lib/loopiator.rb
+ lib/loopiator/client.rb
+ lib/loopiator/credits.rb
+ lib/loopiator/domains.rb
+ lib/loopiator/errors.rb
+ lib/loopiator/extensions/hash.rb
+ lib/loopiator/logger.rb
+ lib/loopiator/models/domain.rb
+ lib/loopiator/railtie.rb
+ loopiator.gemspec
+ spec/loopiator/client_spec.rb
+ spec/loopiator/credits_spec.rb
+ spec/loopiator/domains_spec.rb
+ spec/spec_helper.rb
+ ]
+ # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ %r{^spec/*/.+\.rb} }
+end

data/spec/loopiator/client_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe "Loopiator Api Client"  do
+  describe "- When initializing a new client" do
+
+    describe "- With defaults:" do
+      before(:each) do
+        config = {username:  "test_user",
+                  password:  "test_password",
+                  endpoint:  "https://api.loopia.se/RPCSERV" }
+        
+        Loopiator::Client.any_instance.expects(:set_config).at_least_once.returns(config)
+        
+        @client = Loopiator::Client.new(config)
+      end
+
+      it "should have a username set" do
+      	@client.username.should == "test_user"
+      end
+
+      it "should have a password set" do
+      	@client.password.should == "test_password"
+      end
+      
+      it "should have an endpoint set" do
+      	@client.endpoint.should == "https://api.loopia.se/RPCSERV"
+      end
+
+    end
+
+  end
+end
+

data/spec/loopiator/credits_spec.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe "Credits Management -"  do
+  
+  before(:each) do
+    @client = Loopiator::Client.new
+  end
+  
+  describe "When managing my credits:" do
+    
+    it "I should be able to check how many credits I currently have (with VAT)" do
+    	@client.expects(:get_credits_amount).with(true).once.returns(125)
+    	remaining_credits = @client.get_credits_amount(true)
+    	remaining_credits.should == 125
+    end
+    
+    it "I should be able to check how many credits I currently have (without VAT)" do
+    	@client.expects(:get_credits_amount).with(false).once.returns(100)
+    	remaining_credits = @client.get_credits_amount(false)
+    	remaining_credits.should == 100
+    end
+
+  end
+  
+end
+

data/spec/loopiator/domains_spec.rb

@@ -0,0 +1,75 @@
+# encoding: UTF-8
+
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe "Domain Management -"  do
+  
+  before(:each) do
+    @client = Loopiator::Client.new
+  end
+  
+  describe "When checking domain availability:" do
+    
+    it "I should be able to check that a domain is available" do
+    	@client.domain_is_free('dsadsadsadsadsadsadasdas.se').should == true
+    end
+    
+    it "I should be able to check if a domain is not available" do
+    	@client.domain_is_free('aftonbladet.se').should == false
+    end
+    
+    it "I should be able to check if an IDN-domain is available" do
+    	@client.domain_is_free('såhärtestarmanenidndomänkanske.se').should == true
+    end
+
+  end
+  
+  describe "When managing my domains:" do
+    
+    it "I should be able to check the details for a domain that I own" do
+    	hash        =   {"paid"             =>  1,
+    	                 "unpaid_amount"    =>  0,
+    	                 "registered"       =>  1,
+    	                 "domain"           =>  "testdomain.se",
+    	                 "renewal_status"   =>  "NOT_HANDLED_BY_LOOPIA",
+    	                 "expiration_date"  =>  "UNKNOWN",
+    	                 "reference_no"     =>  "999999"
+    	                }
+    	                
+    	mock        =   Loopiator::Models::Domain.new(hash)
+    	
+    	@client.expects(:get_domain).with('testdomain.se').once.returns(mock)
+    	
+    	domain      =   @client.get_domain('testdomain.se')
+    	
+    	domain.paid?.should               ==  true
+    	domain.needs_to_be_paid?.should   ==  false
+    	domain.registered?.should         ==  true
+    	domain.reference_number.should    ==  "999999"
+    end
+    
+    it "I should be able to see that a domain hasn't been paid for yet." do
+    	hash        =   {"paid"             =>  0,
+    	                 "unpaid_amount"    =>  99,
+    	                 "registered"       =>  1,
+    	                 "domain"           =>  "testdomain.se",
+    	                 "renewal_status"   =>  "NOT_HANDLED_BY_LOOPIA",
+    	                 "expiration_date"  =>  "UNKNOWN",
+    	                 "reference_no"     =>  "1111111"
+    	                }
+    	                
+    	mock        =   Loopiator::Models::Domain.new(hash)
+    	
+    	@client.expects(:get_domain).with('testdomain.se').once.returns(mock)
+    	
+    	domain      =   @client.get_domain('testdomain.se')
+    	
+    	domain.paid?.should               ==  false
+    	domain.needs_to_be_paid?.should   ==  true
+    	domain.unpaid_amount.should       ==  99
+    	domain.reference_number.should    ==  "1111111"
+    end
+
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH << "." unless $LOAD_PATH.include?(".")
+
+begin
+  require "rubygems"
+  require "bundler"
+
+  if Gem::Version.new(Bundler::VERSION) <= Gem::Version.new("0.9.5")
+    raise RuntimeError, "Your bundler version is too old." +
+     "Run `gem install bundler` to upgrade."
+  end
+
+  # Set up load paths for all bundled gems
+  Bundler.setup
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run \`bundlee install\`?"
+end
+
+#require "active_record"
+Bundler.require
+
+require File.expand_path('../../lib/loopiator', __FILE__)
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: loopiator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sebastian Johnsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simpleidn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: mocha
+  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: Interface for communicating with Loopia's API
+email: sebastian@agiley.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/generators/loopiator/loopiator_generator.rb
+- lib/generators/templates/loopia.template.yml
+- lib/loopiator.rb
+- lib/loopiator/client.rb
+- lib/loopiator/credits.rb
+- lib/loopiator/domains.rb
+- lib/loopiator/errors.rb
+- lib/loopiator/extensions/hash.rb
+- lib/loopiator/logger.rb
+- lib/loopiator/models/domain.rb
+- lib/loopiator/railtie.rb
+- loopiator.gemspec
+- spec/loopiator/client_spec.rb
+- spec/loopiator/credits_spec.rb
+- spec/loopiator/domains_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Agiley/Loopiator
+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: 1.3.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 2
+summary: Interface for communicating with Loopia's API
+test_files:
+- spec/loopiator/client_spec.rb
+- spec/loopiator/credits_spec.rb
+- spec/loopiator/domains_spec.rb
+- spec/spec_helper.rb