finance_sync 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/Gemfile

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

data/LICENSE.rdoc

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Vanderson Mota
+
+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.rdoc

@@ -0,0 +1,19 @@
+= finance_sync
+
+Como usar:
+
+require 'finance_sync'
+
+Instancie a classe FinanceSync::Client passando a url do servidor e a versão dos dados que estão na máquina cliente:
+
+  @client = FinanceSync::Client.new(:services_url=>"https://services.myfreecomm.com.br/, :version=>22)
+
+Para sincronizar, você deve mandar um hash com os dados que você alterou desde a última versão:
+
+  @client.synchronize({:dados=>'alterados'})
+
+Para maiores detalhes de como funciona a API do FinanceSync, veja em: git@github.com:myfreecomm/Snakepit.git
+
+Testado apenas com Ruby 1.9.2p180.
+
+Copyright (c) 2010 Vanderson Mota. See LICENSE for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/finance_sync.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "finance_sync/version"
+
+Gem::Specification.new do |s|
+  s.name        = "finance_sync"
+  s.version     = FinanceSync::VERSION
+  s.authors     = ["Vanderson Mota", "Rodrigo Tassinari"]
+  s.email       = ["vanderson.mota@myfreecomm.com.br", "rodrigo.tassinari@myfreecomm.com.br"]
+  s.homepage    = "https://github.com/myfreecomm/finance_sync"
+  s.summary     = %q{Ruby client to the FinanceSync API}
+  s.description = %q{Ruby client to the FinanceSync API}
+
+  s.rubyforge_project = "finance_sync"
+  
+  s.add_development_dependency "rspec", "~> 2.6.0"
+  s.add_development_dependency "fakeweb", "~> 1.3.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/finance_sync/version.rb

@@ -0,0 +1,3 @@
+module FinanceSync
+  VERSION = "0.0.1"
+end

data/lib/finance_sync.rb

@@ -0,0 +1,68 @@
+# -*- encoding: utf-8 -*-
+require "finance_sync/version"
+
+require 'rubygems'
+require 'json'
+require 'net/http'
+
+module FinanceSync
+  
+  class Client
+    attr_reader :version, :entities, :conflicts, :error
+
+    def initialize(params)
+      @services_url = params[:services_url]
+      @version = params[:version]
+      @user = params[:user]
+      @password = params[:password]
+      raise ArgumentError if @user.nil? or @password.nil?
+      raise TypeError unless @version.is_a? Fixnum
+
+      @error = nil
+      @conflicts = []
+    end
+
+    def synchronize(data)
+      data = request_sync(data)
+      return false if data == false
+      @version = data['version']
+      @entities = data['data']
+      @conflicts = data['conflicts']
+      return true
+    end
+
+    protected
+
+      def assemble_data(entities)
+        return {"version" => @version, "data" => entities}
+      end
+
+      def request_sync(entities)
+        data = assemble_data(entities)
+        errors = {"400"=>"bad data", "500"=>"sync server error",
+                  "423"=>"locked", "401"=> "login error"}
+
+        put = Net::HTTP::Put.new("/financedesktop/sync/synchronize")
+        put.basic_auth(@user, @password)
+        put.content_type = 'application/json'
+        begin
+          response = Net::HTTP.start(@services_url) {|http|
+            http.request(put, data.to_json)
+          }
+        rescue SocketError, URI::InvalidURIError
+          @error = 'invalid url'
+          return false
+        end
+
+        case response
+          when Net::HTTPSuccess
+            return JSON.parse(response.body)
+          else
+            @error = errors[response.code]
+            return false
+          end
+      end
+      
+  end
+  
+end

data/spec/finance_sync_spec.rb

@@ -0,0 +1,287 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+ENTITIES = [
+              {"entity"=>
+                {"currency"=> "BRL", "payee"=> nil, "amount"=> "100.00000000",
+                 "imported"=> false, "description"=> "Novo lançamento",
+                  "payer"=> "Rendimento aplicação", "base_date"=> "2010-03-16T11=>29=>02.354014",
+                  "document_number"=> 1, "guid"=> "ffffffffffffffffffffffffffffffff"
+                }
+              }
+            ]
+
+
+UPDATED_VERSION = '{"conflicts": [], "version": 49, "data": [{"entity": {"imported": "true",
+                "description": "roupa", "document-number": 111, "amount": "200.00000000",
+                "date": "2010-10-11", "guid": "22a648b0-2fe1-4888-96a4-caa27a4c27d7",
+                "type": "transaction"}}]}'
+
+USER = 'jalim'
+PASSWORD = 'habei'
+
+describe FinanceSync::Client do
+  
+  def fake_sync_response(response, user='', password='')
+    if not (user.empty? and password.empty?)
+      credentials = "#{user}:#{password}@"
+    else
+      credentials = ""
+    end
+    FakeWeb.register_uri(
+        :put,
+        "http://#{credentials}services.myfreecomm.com.br/financedesktop/sync/synchronize",
+        response)
+  end
+
+  before(:each) do
+    @services_url = "services.myfreecomm.com.br"
+    @finance_sync = FinanceSync::Client.new(:services_url => @services_url, :version => 2,
+                                    :user=>USER, :password=>PASSWORD)
+  end
+
+  it "should have .version" do
+    @finance_sync = FinanceSync::Client.new(:services_url=>@services_url, :version => 4,
+                                    :user=>USER, :password=>PASSWORD)
+    @finance_sync.version.should == 4
+  end
+
+  describe "initializer" do
+    it "should store version" do
+      @finance_sync.instance_variable_get(:@version).should == 2
+    end
+
+    it "should store services_url" do
+      @finance_sync.instance_variable_get(:@services_url).should == 'services.myfreecomm.com.br'
+    end
+  end
+
+
+  describe "synchronizer" do
+    it "should send the params formed correctly" do
+      @finance_sync = FinanceSync::Client.new(:services_url => @services_url, :version => 48,
+                                      :user=>USER, :password=>PASSWORD)
+      correct_json = {"version"=>@finance_sync.version, "data"=>ENTITIES}.to_json
+
+      put = mock(Net::HTTP::Put)
+      Net::HTTP::Put.should_receive(:new).with("/financedesktop/sync/synchronize").once.and_return(put)
+      put.should_receive(:basic_auth).with(USER, PASSWORD)
+      put.should_receive(:content_type=).with('application/json')
+
+      http = mock()
+      http.should_receive(:request).with(put, correct_json)
+
+      http_success_mock = mock(Net::HTTPSuccess)
+      http_success_mock.stub!(:code).and_return("200")
+      http_success_mock.stub!(:body).and_return(UPDATED_VERSION)
+
+      Net::HTTP.should_receive(:start).with(@services_url).and_yield(http).and_return(http_success_mock)
+     @finance_sync.synchronize(ENTITIES)
+    end
+
+    describe "with not found url" do
+      before(:each) do
+        @invalid_url = 'invalid_url'
+        @finance_sync = FinanceSync::Client.new(:services_url => @invalid_url, :version => 48,
+                                        :user=>USER, :password=>PASSWORD)
+        @correct_json = {"version"=>@finance_sync.version, "data"=>ENTITIES}.to_json
+
+        @put = mock(Net::HTTP::Put)
+        Net::HTTP::Put.should_receive(:new).with("/financedesktop/sync/synchronize").once.and_return(@put)
+        @put.should_receive(:basic_auth).with(USER, PASSWORD)
+        @put.should_receive(:content_type=).with('application/json')
+        http = mock()
+        Net::HTTP.should_receive(:start).with(@invalid_url).and_raise(SocketError)
+      end
+      it "should return false" do
+        @finance_sync.synchronize(ENTITIES).should be_false
+      end
+      it "should return set 'invalid url' error" do
+        @finance_sync.synchronize(ENTITIES)
+        @finance_sync.error.should == 'invalid url'
+      end
+    end
+
+    describe "with invalid url" do
+      before(:each) do
+        @finance_sync = FinanceSync::Client.new(:services_url => nil, :version => 48,
+                                        :user=>USER, :password=>PASSWORD)
+      end
+      it "should return false" do
+        @finance_sync.synchronize(ENTITIES).should be_false
+      end
+      it "should set 'invalid url' error" do
+        @finance_sync.synchronize(ENTITIES)
+        @finance_sync.error.should == 'invalid url'
+      end
+    end
+
+    describe "with invalid version specified" do
+      it "should raise TypeError if a non integer is passed " do
+        wrong_params = {:services_url => "services.myfreecomm.com.br",
+                        :version => "abcsd", :user=>USER, :password=>PASSWORD}
+        lambda {
+          FinanceSync::Client.new(wrong_params)
+        }.should raise_exception(TypeError)
+      end
+    end
+
+    describe "with wrong credentials provided" do
+      before(:each) do
+        fake_sync_response({:status=>[401, "unauthorized"]}, 'wrong', 'credential' )
+        @finance_sync = FinanceSync::Client.new(:services_url => @services_url, :version => 48,
+                                        :user=>'wrong', :password=>'credential')
+      end
+      it "should return false " do
+        @finance_sync.synchronize(ENTITIES).should be_false
+      end
+      it "should set 'login error'" do
+        @finance_sync.synchronize(ENTITIES).should be_false
+        @finance_sync.error.should == 'login error'
+      end
+    end
+
+    describe "with no credentials provided" do
+      it "should raise 'Argument Error'" do
+        lambda {
+          FinanceSync::Client.new(:services_url => @services_url, :version => 48)
+        }.should raise_exception(ArgumentError)
+      end
+    end
+
+    describe "with no conflicts and no new data" do
+      before(:each) do
+        @finance_sync = FinanceSync::Client.new(:services_url => "services.myfreecomm.com.br",
+                                        :version => 48, :user=>'wrong',
+                                        :password=>'credentials' )
+        fake_sync_response({:status=>[200, "OK"],
+                            :body=>'{"conflicts": [], "version": 48, "data": []}'},
+                            'wrong', 'credentials')
+      end
+      it "should not update version" do
+        lambda {
+          @finance_sync.synchronize(ENTITIES)
+        }.should_not change(@finance_sync, :version)
+      end
+      it "should not populate conflicts" do
+        lambda {
+          @finance_sync.synchronize(ENTITIES)
+        }.should_not change(@finance_sync, :conflicts)
+      end
+      it "should return true" do
+        @finance_sync.synchronize(ENTITIES).should be_true
+      end
+    end
+
+    describe "with no conflicts and new data from sync server" do
+      before(:each) do
+        @finance_sync = FinanceSync::Client.new(:services_url => "services.myfreecomm.com.br",
+                                        :version => 48, :user=>'wrong',
+                                        :password=>'credentials')
+        fake_sync_response({:status=>[200, "OK"], :body=>UPDATED_VERSION},
+                           'wrong', 'credentials')
+      end
+      it "should populate entities" do
+        @finance_sync.synchronize(ENTITIES)
+        @finance_sync.entities.should_not be_empty
+      end
+      it "should update version" do
+        @finance_sync.synchronize(ENTITIES)
+        @finance_sync.version.should == 49
+      end
+      it "should not have conflicts" do
+        @finance_sync.synchronize(ENTITIES)
+        @finance_sync.conflicts.should be_empty
+      end
+      it "should return true" do
+        @finance_sync.synchronize(@old_transaction).should be_true
+      end
+    end
+
+  end
+
+  describe "with bad data" do
+    before(:each) do
+      fake_sync_response({:status=>[400, "Bad request"], :body=>"invalid data"},
+                         USER, PASSWORD)
+      @bad_data = '{"version": 47, "entity":}'
+    end
+
+    it "should set error 'bad data'" do
+      @finance_sync.synchronize(@bad_data)
+      @finance_sync.error.should == "bad data"
+    end
+
+    it "should return false" do
+      @finance_sync.synchronize(@bad_data).should be_false
+    end
+
+  end
+
+  describe "on sync server error" do
+
+    before(:each) do
+      fake_sync_response({:status=>[500, "Server Error"], :body=>"Server Error"},
+                         USER, PASSWORD)
+      @valid_data = '{"valid": "data"}'
+    end
+
+    it "should set error 'sync server error'" do
+      @finance_sync.synchronize(@valid_data)
+      @finance_sync.error.should == "sync server error"
+    end
+
+    it "should return false" do
+      @finance_sync.synchronize(@valid_data).should be_false
+    end
+
+  end
+
+  describe "on sync server lock" do
+
+    before(:each) do
+      fake_sync_response({:status=>[423, "Locked"], :body=>"Locked"}, USER, PASSWORD)
+      @valid_data = '{"valid": "data"}'
+    end
+
+    it "should set error 'sync server error'" do
+      @finance_sync.synchronize(@valid_data)
+      @finance_sync.error.should == "locked"
+    end
+
+    it "should return false" do
+      @finance_sync.synchronize(@valid_data).should be_false
+    end
+
+  end
+
+  describe "with any error" do
+    before(:each) do
+      @finance_sync.stub!(:request_sync).and_return(false)
+    end
+
+    it "should not alter sync version" do
+      lambda {
+        @finance_sync.synchronize(@valid_data)
+        }.should_not change(@finance_sync, :version)
+    end
+
+    it "should not populate conflicts" do
+      lambda {
+        @finance_sync.synchronize(@valid_data)
+        }.should_not change(@finance_sync, :conflicts)
+    end
+
+    it "should not update entities" do
+      lambda {
+        @finance_sync.synchronize(@valid_data)
+        }.should_not change(@finance_sync, :entities)
+    end
+
+    it "should return false" do
+      @finance_sync.synchronize(@valid_data).should be_false
+    end
+
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# -*- encoding: utf-8 -*-
+require "bundler/setup"
+require 'fakeweb'
+require File.join(File.dirname(__FILE__), '../lib', 'finance_sync')

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: finance_sync
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Vanderson Mota
+- Rodrigo Tassinari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-08 00:00:00.000000000 -03:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157289460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157289460
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &2157288960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157288960
+description: Ruby client to the FinanceSync API
+email:
+- vanderson.mota@myfreecomm.com.br
+- rodrigo.tassinari@myfreecomm.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.rdoc
+- README.rdoc
+- Rakefile
+- finance_sync.gemspec
+- lib/finance_sync.rb
+- lib/finance_sync/version.rb
+- spec/finance_sync_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/myfreecomm/finance_sync
+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: finance_sync
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby client to the FinanceSync API
+test_files:
+- spec/finance_sync_spec.rb
+- spec/spec_helper.rb