poseidon-api 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rake', "10.0.3"
+
+# Specify your gem's dependencies in poseidon-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Maximiliano Dello Russo
+
+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,37 @@
+# Poseidon::Api
+
+Cliente para interactuar con la API del sistema Poseidon.
+
+## Instalación
+
+Agregar la siguiente linea a su Gemfile:
+
+    gem 'poseidon-api'
+
+Y luego ejecutar:
+
+    $ bundle
+
+O instalar directamente: 
+
+    $ gem install poseidon-api
+
+## Modo de uso
+
+    api = Poseidon::API(url: 'http://poseidon-url.com', user: 'user@test.com', password: '12345')
+    invoice = Poseidon::Invoice.new ...
+    ...
+    emitted = api.emit_invoice(invoice)
+
+Retorna un booleano que indica si pudo o no emitir la factura.
+
+En caso de no emitir la factura se pueden verificar los errores utilizando el método 'errors'
+
+
+## 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,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+end
+
+task :default => :test

data/lib/poseidon-api/version.rb

@@ -0,0 +1,5 @@
+module Poseidon
+  module Api
+    VERSION = "0.0.1"
+  end
+end

data/lib/poseidon-api.rb

@@ -0,0 +1,152 @@
+require "poseidon-api/version"
+require 'json'
+require 'curb'
+
+# Cliente para interactuar con la API del sistema poseidon.
+#
+# Ejemplo:
+#
+#     api = Poseidon::API(url: 'http://poseidon-url.com', user: 'user@test.com', password: '12345')
+#     invoice = Poseidon::Invoice.new ...
+#     ...
+#     emitted = api.emit_invoice(invoice)
+#
+# Retorna un booleano que indica si pudo o no emitir la factura.
+#
+# En caso de no emitir la factura se pueden verificar los errores utilizando el método 'errors'
+#
+module Poseidon
+  class API
+
+    attr_reader :token, :errors  
+
+    # El constructor requiere los atributos:
+    # 
+    # + url: URL de la aplicación Poseidon.
+    # + user: Identificador del usuario poseidon que ingresa (email).
+    # + password: Contraseña de acceso.
+    # + version: Versión de la API a utilizar.
+    #
+    def initialize(properties)
+      @service_url = properties[:url]
+      @user = properties[:user]
+      @password = properties[:password]
+      @errors = []
+      @version = properties[:version] || 'v1'
+    end
+
+    def login
+      json = { :email => @user, :password => @password }.to_json
+      curl = post(token_uri, json)
+      if curl.response_code == 200
+        response = JSON.parse(curl.body_str)
+        @token = response['token']
+        return true
+      else
+        response = JSON.parse(curl.body_str)
+        @errors << response['error']
+        return false
+      end    
+    end
+
+    def emit_invoice(invoice)
+      login if @token.nil? 
+      curl = post(facturas_uri, invoice.to_json)
+      status_code = curl.response_code
+      # TODO analizar que sucede si hay un token pero la petición retorna error 401 (unauthorized)
+      # Debería volver a pedirse un token y reintentar?
+      if curl.response_code == 201 # created
+        return true 
+      else
+        response = JSON.parse(curl.body_str)
+        @errors.clear << response['error']
+        return false
+      end
+    end
+
+    def hello
+      'world'
+    end
+
+    private 
+
+    def post(uri, json)
+      c = Curl.post(uri, json) do |curl|
+        curl.headers['Content-Type'] = 'application/json'
+      end
+      #c.perform
+      c
+    end
+
+    def api_uri
+      "#{@service_url}/api/#{@version}"
+    end
+
+    def token_uri
+      "#{api_uri}/tokens"
+    end
+
+    def facturas_uri
+      "#{api_uri}/facturas.json?auth_token=#{@token}"
+    end
+
+  end
+
+
+  class Invoice
+    attr_accessor :date, :sale_point, :number, :client, :details
+
+    def initialize(attrs)
+      @date = attrs[:date] || Date.now
+      @sale_point = attrs[:sale_point]
+      @number = attrs[:number]
+      @client = attrs[:client]
+      @details = []
+    end
+
+    def to_hash
+      { factura: {
+          fecha: @date,
+          sale_point: @sale_point,
+          numero: @number,
+          cliente: @client.to_hash,
+          detalles: @details.map { |detail| detail.to_hash } 
+        }
+      }
+    end
+
+    def to_json
+      to_hash.to_json
+    end
+  end
+
+  class Client
+    attr_accessor :name, :cuit, :iva_condition_id
+
+    def initialize(attrs)
+      @name = attrs[:name]
+      @cuit = attrs[:cuit]
+      @iva_condition_id = attrs[:iva_condition_id]
+    end
+
+    def to_hash
+      { razonsocial: @name, cuit_number: @cuit, condicioniva_id: @iva_condition_id }
+    end
+  end
+
+  class Detail
+    attr_accessor :amount, :unit_price, :description, :iva_rate
+
+    def initialize(attrs)
+      @amount = attrs[:amount]
+      @unit_price = attrs[:unit_price]
+      @description = attrs[:description]
+      @iva_rate = attrs[:iva_rate]
+    end
+
+    def to_hash
+      { cantidad: @amount, preciounitario: @unit_price, descripcion: @description, tasaiva: @iva_rate }
+    end
+  end
+
+end

data/poseidon-api.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'poseidon-api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "poseidon-api"
+  gem.version       = Poseidon::Api::VERSION
+  gem.authors       = ["Maximiliano Dello Russo"]
+  gem.email         = ["maxidr@gmail.com"]
+  gem.description   = %q{An API to interact with the Poseidon system}
+  gem.summary       = %q{API client for Poseidon system}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency('protest', '0.4.0')
+  gem.add_development_dependency('vcr', '2.4.0')
+  gem.add_development_dependency('webmock', '1.9.3')
+  gem.add_dependency('curb', '0.8.3')
+  
+end

data/test/fixtures/vcr_cassetes/failed_login.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3000/api/v1/tokens
+    body:
+      encoding: UTF-8
+      string: ! '{"email":"lmpetek@gmail.com","password":""}'
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 401
+      message: !binary |-
+        VW5hdXRob3JpemVkIA==
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtOA==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bm8tY2FjaGU=
+      !binary "WC1VYS1Db21wYXRpYmxl":
+      - !binary |-
+        SUU9RWRnZQ==
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC40MjU4NDI=
+      !binary "U2VydmVy":
+      - !binary |-
+        V0VCcmljay8xLjMuMSAoUnVieS8xLjkuMy8yMDEyLTA0LTIwKQ==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAwMiBNYXIgMjAxMyAxMzoxMjoxMSBHTVQ=
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        NDM=
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        S2VlcC1BbGl2ZQ==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJlcnJvciI6IkVtYWlsIG8gcGFzc3dvcmQgaW52XHUwMGUxbGlkb3MifQ==
+    http_version: 
+  recorded_at: Sat, 02 Mar 2013 13:12:11 GMT
+recorded_with: VCR 2.4.0

data/test/fixtures/vcr_cassetes/success_login.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3000/api/v1/tokens
+    body:
+      encoding: UTF-8
+      string: ! '{"email":"lmpetek@gmail.com","password":"123456"}'
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0sg
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtOA==
+      !binary "RXRhZw==":
+      - !binary |-
+        IjJhZjAzZDgwMmZiM2U1YTFiZWZkMmNkNWE4ZDY1MjM1Ig==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bWF4LWFnZT0wLCBwcml2YXRlLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "WC1VYS1Db21wYXRpYmxl":
+      - !binary |-
+        SUU9RWRnZQ==
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC40NDA2OTg=
+      !binary "U2VydmVy":
+      - !binary |-
+        V0VCcmljay8xLjMuMSAoUnVieS8xLjkuMy8yMDEyLTA0LTIwKQ==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAwMiBNYXIgMjAxMyAxMzoxMjoxMSBHTVQ=
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MzI=
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        S2VlcC1BbGl2ZQ==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJ0b2tlbiI6InlOem81MUt1Zk12ZXRabmVvN2NEIn0=
+    http_version: 
+  recorded_at: Sat, 02 Mar 2013 13:12:11 GMT
+recorded_with: VCR 2.4.0

data/test/fixtures/vcr_cassetes/valid_invoice.yml

@@ -0,0 +1,108 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3000/api/v1/tokens
+    body:
+      encoding: UTF-8
+      string: ! '{"email":"lmpetek@gmail.com","password":"123456"}'
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0sg
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtOA==
+      !binary "RXRhZw==":
+      - !binary |-
+        IjJhZjAzZDgwMmZiM2U1YTFiZWZkMmNkNWE4ZDY1MjM1Ig==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bWF4LWFnZT0wLCBwcml2YXRlLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "WC1VYS1Db21wYXRpYmxl":
+      - !binary |-
+        SUU9RWRnZQ==
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC4zNDUwMTI=
+      !binary "U2VydmVy":
+      - !binary |-
+        V0VCcmljay8xLjMuMSAoUnVieS8xLjkuMy8yMDEyLTA0LTIwKQ==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAwMiBNYXIgMjAxMyAxMzoxMDo1MCBHTVQ=
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MzI=
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        S2VlcC1BbGl2ZQ==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJ0b2tlbiI6InlOem81MUt1Zk12ZXRabmVvN2NEIn0=
+    http_version: 
+  recorded_at: Sat, 02 Mar 2013 13:10:50 GMT
+- request:
+    method: post
+    uri: http://localhost:3000/api/v1/facturas.json?auth_token=yNzo51KufMvetZneo7cD
+    body:
+      encoding: UTF-8
+      string: ! '{"factura":{"fecha":"2013-03-02","sale_point":1,"numero":5428551,"cliente":{"razonsocial":"Los
+        alerces","cuit_number":20233119354,"condicioniva_id":1},"detalles":[{"cantidad":10,"preciounitario":15.5,"descripcion":"detalle","tasaiva":21.0},{"cantidad":8,"preciounitario":35.0,"descripcion":"detalle","tasaiva":21.0}]}}'
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 201
+      message: !binary |-
+        Q3JlYXRlZCA=
+    headers:
+      !binary "TG9jYXRpb24=":
+      - !binary |-
+        aHR0cDovL2xvY2FsaG9zdDozMDAwL2NsaWVudGVzLzE0L2ZhY3R1cmFzLzMy
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtOA==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bm8tY2FjaGU=
+      !binary "WC1VYS1Db21wYXRpYmxl":
+      - !binary |-
+        SUU9RWRnZQ==
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MS4yMDk1ODQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        V0VCcmljay8xLjMuMSAoUnVieS8xLjkuMy8yMDEyLTA0LTIwKQ==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAwMiBNYXIgMjAxMyAxMzoxMDo1MSBHTVQ=
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MQ==
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        S2VlcC1BbGl2ZQ==
+      !binary "U2V0LUNvb2tpZQ==":
+      - !binary |-
+        X3Bvc2VpZG9uX3Nlc3Npb249QkFoN0Iwa2lHWGRoY21SbGJpNTFjMlZ5TG5W
+        elpYSXVhMlY1QmpvR1JWUmJDRWtpQ1ZWelpYSUdPd0JHV3dacEJra2lJaVF5
+        WVNReE1DUkNOMjVGTkZwTE1VOUljbk13V2xwT2JVeENaazVQQmpzQVZFa2lE
+        M05sYzNOcGIyNWZhV1FHT3dCR0lpVTNZalZpTUdOaU5HWmtNak16TXpJM09H
+        UXhPVGcyTXpGaE1UZzJZbUl4WWclM0QlM0QtLWM3MzA4OWM2MjMwMDAzNDFl
+        NzVlYWIyOWNlZmE0YzA0MWU0YTYzZjU7IHBhdGg9LzsgSHR0cE9ubHk=
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        IA==
+    http_version: 
+  recorded_at: Sat, 02 Mar 2013 13:10:51 GMT
+recorded_with: VCR 2.4.0

data/test/test_poseidon_api.rb

@@ -0,0 +1,60 @@
+require 'protest'
+require 'poseidon-api'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/fixtures/vcr_cassetes'
+  c.hook_into :webmock
+end
+
+
+def valid_properties
+  { :user => 'lmpetek@gmail.com', :password => '123456', url: 'http://localhost:3000' }
+end
+
+def login
+  api = Poseidon::API.new(valid_properties)
+  api.login
+  api
+end
+
+def generate_invoice
+  invoice = Poseidon::Invoice.new(date: Date.today, sale_point: 1, number: Random.rand(1..9999999))
+  invoice.client = Poseidon::Client.new(name: 'Los alerces', cuit: 20233119354, iva_condition_id: 1)
+  [ { amount: 10, unit_price: 15.50, description: 'detalle', iva_rate: 21.0 },
+    { amount: 8, unit_price: 35.0, description: 'detalle', iva_rate: 21.0 } ].each do |params|
+    invoice.details << Poseidon::Detail.new(params)
+  end
+  invoice
+end
+
+Protest.describe('api') do
+
+  test 'success login' do
+    VCR.use_cassette('success_login') do
+      api = Poseidon::API.new(valid_properties)
+      assert api.login
+      assert api.errors.empty?
+    end
+  end
+
+  test 'failed login' do
+    VCR.use_cassette('failed_login') do
+      properties = valid_properties.clone
+      properties[:password] = ''
+      api = Poseidon::API.new(properties)
+      assert api.login == false
+      assert !api.errors.empty?
+    end
+  end
+
+  test 'emit invoice successul' do
+    VCR.use_cassette('valid_invoice') do 
+      api = Poseidon::API.new(valid_properties)
+      result = api.emit_invoice(generate_invoice)
+      assert result   
+      assert api.errors.empty?
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: poseidon-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Maximiliano Dello Russo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: protest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+description: An API to interact with the Poseidon system
+email:
+- maxidr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/poseidon-api.rb
+- lib/poseidon-api/version.rb
+- poseidon-api.gemspec
+- test/fixtures/vcr_cassetes/failed_login.yml
+- test/fixtures/vcr_cassetes/success_login.yml
+- test/fixtures/vcr_cassetes/valid_invoice.yml
+- test/test_poseidon_api.rb
+homepage: ''
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: API client for Poseidon system
+test_files:
+- test/fixtures/vcr_cassetes/failed_login.yml
+- test/fixtures/vcr_cassetes/success_login.yml
+- test/fixtures/vcr_cassetes/valid_invoice.yml
+- test/test_poseidon_api.rb
+has_rdoc: