api_registro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbf83e994f40555ae914dbec6c76c8387739e308
+  data.tar.gz: 79179e27ee44f7e4fe258a21f2906cafb6bfd298
+SHA512:
+  metadata.gz: 00637fef648f80c1c04a8a45ab08f42898f63741417c12685cef9912adb408c669bea80c60b46abd2e971dd0f89144d3044947396e8fbd3ca9d8a789ba9394c6
+  data.tar.gz: 57c0c406d645fccb7cc1fff441908eebcdbe5d74e357b3205eb7e18d5f18d062f468b0153ea92b4af7a4a8ba1c782f11e3b46d2923ef594f532785b12f39f5fd

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Daniel Quirino Oliveira
+
+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,35 @@
+# ApiRegistro
+
+A simple client for APIRegistro Domain registration API service (http://apiregistro.com.br).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'api_registro'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_registro
+
+## Usage
+
+    client = ApiRegistro.client("INSERT YOUR TOKEN HERE") # uses production environment.
+    client = ApiRegistro.client("INSERT YOUR TOKEN HERE", ApiRegistro::Environments::SANDBOX) #uses sandbox environment for testing purposes.
+    h = {name: "John  Doe", document: "111.111.111-11", email: "john@email.com"}
+    response = client.create_contact(h) # creates a contact
+    contact_json = client.find_contact("111.111.111-11") # retrieves a contact using contact's CPF.
+    response = client.find_domain("mydomain.com.br") # retrieves domain registration information
+    response = client.register_domain("mydomain.com.br", "111.111.111-11") # register domain testejoopp.com to contact assigned to CPF 111.111.111-11
+
+## 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,2 @@
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks

data/api_registro.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_registro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api_registro"
+  spec.version       = ApiRegistro::VERSION
+  spec.authors       = ["Daniel Quirino Oliveira"]
+  spec.email         = ["danielqo@gmail.com"]
+  spec.description   = %q{A client for APIRegistro.com.br API}
+  spec.summary       = %q{APIRegistro.com.br API client}
+  spec.homepage      = "https://github.com/danielqo/api_registro_rb"
+  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_dependency             "httparty"
+end

data/lib/api_registro/client.rb

@@ -0,0 +1,78 @@
+module ApiRegistro
+  class Client
+    include ApiRegistro::HTTPSupport
+    
+    def initialize(token, environment)
+      @token = token
+      @env   = environment
+    end
+    
+    def create_contact(opts={})
+      message = {
+        headers:    { "Accept"        => "application/json", 
+                      "Content-Type"  => "application/json",
+                      "Authorization" => "Token #{@token}"
+                    },
+        body: opts.to_json
+      }
+      request(url_for(:create_contact), ApiRegistro::SupportedMethods::POST, message)
+    end
+    
+    def find_contact(document_number)
+      message = {
+        headers:    { "Accept" => "application/json", "authorization" => @token }
+      }
+      request(url_for(:find_contact, document_number), ApiRegistro::SupportedMethods::GET, message)
+    end
+    
+    def register_domain(domain, document_number)
+      message = {
+        headers:    { "Accept"        => "application/json", 
+                      "Content-Type"  => "application/json",
+                      "Authorization" => "Token #{@token}"
+                    },
+        body: {document: document_number}.to_json
+      }
+      request(url_for(:register_domain, domain), ApiRegistro::SupportedMethods::POST, message)
+    end
+    
+    def find_domain(domain_name)
+      message = {
+        headers:    { "Accept" => "application/json", "authorization" => @token }
+      }
+      request(url_for(:find_domain, domain_name), ApiRegistro::SupportedMethods::GET, message)
+    end
+    
+    private
+    
+    def request(url, http_method, message)
+      response = http_request(url, http_method, message)
+      if(response.code == 200)
+        response.body
+      else
+        nil
+      end
+    end
+    
+    def uris
+      {
+          create_contact:  "contacts/",
+          find_contact:    "contacts/%s",
+          register_domain: "domains/%s/buy/",
+          find_domain:     "domains/?search=%s"
+      }
+    end
+    
+    def base_url
+      @env == ApiRegistro::Environments::PRODUCTION ? 
+                    "http://apiregistro.com.br/api/v1" : 
+                    "http://sandbox.apiregistro.com.br/api/v1"
+    end
+    
+    def url_for(resource, *params)
+      uri = uris[resource] % params
+      "#{base_url}/#{uri}"
+    end
+    
+  end
+end

data/lib/api_registro/http_support.rb

@@ -0,0 +1,26 @@
+require 'httparty'
+
+module ApiRegistro
+  
+  module SupportedMethods
+    POST = :post
+    GET = :get
+    PUT = :put
+    DELETE = :delete
+    ALL = [POST, GET, PUT, DELETE]
+  end
+  
+  module HTTPSupport
+
+    def http_request(resource_url, http_method, message={}, &block)
+      if(ApiRegistro::SupportedMethods::ALL.include? http_method)
+        response = HTTParty.send(http_method, resource_url, message)
+        response = yield(response) if block_given?
+        response
+      else
+        raise ArgumentError, "Unsupported HTTP method #{http_method}"
+      end
+    end
+  end
+
+end

data/lib/api_registro/version.rb

@@ -0,0 +1,3 @@
+module ApiRegistro
+  VERSION = "0.1.0"
+end

data/lib/api_registro.rb

@@ -0,0 +1,17 @@
+module ApiRegistro
+  
+  module Environments
+    SANDBOX    = "sandbox"
+    PRODUCTION = "production"
+    ALL        = [SANDBOX, PRODUCTION]
+  end
+
+  def self.client(token, environment=Environments::PRODUCTION)
+    ApiRegistro::Client.new(token, environment)
+  end
+
+end
+
+require 'api_registro/version'
+require 'api_registro/http_support'
+require 'api_registro/client'

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: api_registro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Quirino Oliveira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-25 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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A client for APIRegistro.com.br API
+email:
+- danielqo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- api_registro.gemspec
+- lib/api_registro.rb
+- lib/api_registro/client.rb
+- lib/api_registro/http_support.rb
+- lib/api_registro/version.rb
+homepage: https://github.com/danielqo/api_registro_rb
+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.1.11
+signing_key: 
+specification_version: 4
+summary: APIRegistro.com.br API client
+test_files: []