alegra 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe72ddb175b67a063af16e4edbf8667eeb5f3f0b
+  data.tar.gz: 153028fb170b9b94b4f24de326e4b047936c178d
+SHA512:
+  metadata.gz: 677d0d327b02314520490ff13524c27fa032bf8fd6f08045a551a530f15ad99cfb4b26accf9a13ad49b3d6b2debda86f14359f237b3fa977813b334a9c8f6ae3
+  data.tar.gz: bbeab0df754e76f143bc738ec7973eb99181eabf2a3baf803af861a217bca6dcab7fa2204a26725b08372ecf95df4692926ff66d01528b4a71cf6e5da97ebd3a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at santilopez114@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Santiago Lopez
+
+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,119 @@
+# Alegra
+
+A ruby client for connecting to [Alegra](http://www.alegra.com)'s API. 
+
+Please check the official API documentation [here](http://developer.alegra.com/) 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alegra'
+```
+
+And then execute:
+
+    $ bundle install 
+
+Or install it yourself as:
+
+    $ gem install alegra
+
+## Usage
+
+```ruby
+
+require 'alegra'
+client = Alegra::Client.new('youremail@test.com', 'your-private-token')
+```
+
+### Contacts
+
+You can list all your contacts:
+```ruby
+client.contacts.list()
+```
+
+Get a specific contact by id:
+
+```ruby
+client.contacts.find(1)
+```
+
+And you can create a contact as well:
+
+```ruby
+params = {
+  name: 'Alan Britho'
+}
+client.contacts.create(params)
+```
+
+### Invoices 
+
+You can get all invoices:
+```ruby 
+client.invoices.list()
+```
+
+Or get a specific invoice by id:
+```ruby
+client.invoices.find(1) # the parameter is the inovice id
+```
+
+Also you are able to create a new invoice, as follows:
+```ruby
+params = {
+          date: '2016-10-12',
+          due_date: '2016-10-12',
+          client: 1,
+          items: [
+                    {
+                        id: 1,
+                        price: 40,
+                        quantity: 5
+                    },
+                    {
+                        id: 2,
+                        description: 'Brown leather wallet',
+                        price: 80,
+                        discount: 10,
+                        tax: [
+                                {
+                                    id: 3,
+                                }
+                             ],
+                        quantity: 1
+                    }
+                  ],
+          account_number: 1234,
+          payment_method: 'cash',
+          stamp: {
+            generate_stamp: true
+          },
+        }
+
+client.invoices.create(params)
+```
+
+## Development
+
+This gem is under construction and I'm writing it as I would like to use it. However, if you have any recommendation is well received. 
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/degzcs/alegra. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Contributors
+
+- Diego Gomez
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/alegra.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alegra/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alegra"
+  spec.version       = Alegra::VERSION
+  spec.authors       = ["Diego Gomez"]
+  spec.email         = ["diego.f.gomez.pardo@gmail.com"]
+
+  spec.summary       = %q{Gem to wrap Alegra API.}
+  spec.description   = %q{Gem to wrap Alegra API. This is unofficial gem (until now)}
+  spec.homepage      = "https://github.com/degzcs/alegra"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 3"
+  spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "jazz_fingers", "~> 4"
+
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "json", "~> 1.7"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "alegra"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/alegra.rb

@@ -0,0 +1,6 @@
+require 'alegra/utilities/hash'
+require 'alegra/client'
+require 'alegra/version'
+
+module Alegra
+end

data/lib/alegra/client.rb

@@ -0,0 +1,30 @@
+require 'alegra/setup'
+require 'alegra/request'
+require 'alegra/invoices'
+require 'alegra/contacts'
+
+module Alegra
+  class Client
+    def initialize(username=nil, apikey=nil, debug=false)
+      @setup = Alegra::Setup.new(username, apikey, debug)
+    end
+
+    def get(url, params={})
+      request = Alegra::Request.new(@setup.host, @setup.path, @setup.token)
+      request.get(url, params)
+    end
+
+    def post(url, params={})
+      request = Alegra::Request.new(@setup.host, @setup.path, @setup.token)
+      request.post(url, params)
+    end
+
+    def invoices
+      Alegra::Invoices.new(self)
+    end
+
+    def contacts
+      Alegra::Contacts.new(self)
+    end
+  end
+end

data/lib/alegra/contacts.rb

@@ -0,0 +1,29 @@
+module Alegra
+  class Contacts
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    # @param id [ Interger ]
+    # @return [ Hash ]
+    def find(id)
+      client.get("contacts/#{ id }")
+    end
+
+    # Returs all contacts
+    # @return [ Array ]
+    def list()
+      client.get('contacts')
+    end
+
+    # @param params [ Hash ]
+    #   - name [ String ]
+    # @return [ Hash ]
+    def create(params)
+      _params = params.deep_camel_case_lower_keys
+      client.post('contacts', _params)
+    end
+  end
+end

data/lib/alegra/invoices.rb

@@ -0,0 +1,44 @@
+module Alegra
+  class Invoices
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    # @param id [ Interger ]
+    # @return [ Hash ]
+    def find(id)
+      client.get("invoices/#{ id }")
+    end
+
+    # Returs all invoices
+    # @return [ Array ]
+    def list()
+      client.get('invoices')
+    end
+
+    # Creates a invoice
+    # @param params [ Hash ]
+    #   - date [ String ]
+    #   - due_date [ String ]
+    #   - price_list [ Array ]
+    #   - currency [ Array ]
+    #   - payments [ Array ]
+    #   - client [ Integer ] or [ Hash ]
+    #   - items [ Array ]
+    #   - observations [ Array ]
+    #   - anotations [ Array ]
+    #   - terms_conditions [ Array ]
+    #   - status [ String ]
+    #   - number_template [ String ]
+    #   - retenctions [ Array ]
+    #   - seller [ String ]
+    # @return [ Hash ]
+    def create(params)
+      _params = params.deep_camel_case_lower_keys
+      client.post('invoices', _params)
+    end
+  end
+end
+

data/lib/alegra/request.rb

@@ -0,0 +1,50 @@
+module Alegra
+  class Request
+    attr_accessor :path, :token, :session
+
+    def initialize(host, path, token=nil)
+      @token = token
+      @path = path
+      @session = Faraday.new url: host
+    end
+
+    def get(url, params={})
+        params = JSON.generate(params)
+        response = @session.get do |req|
+          req.url "#{ @path }#{ url }"
+          req.headers['Content-Type'] = 'application/json'
+          req.headers['Accept'] = 'application/json'
+          req.headers['Authorization'] = "Basic #{ @token }"
+        end
+        cast_error(response) unless (response.status == 200 || response.status == 201)
+        return JSON.parse(response.body)
+    end
+
+    def post(url, params={})
+        params = JSON.generate(params)
+        response = @session.post do |req|
+          req.url "#{ @path }#{ url }"
+          req.headers['Content-Type'] = 'application/json'
+          req.headers['Accept'] = 'application/json'
+          req.headers['Authorization'] = "Basic #{ @token }"
+          req.body = params
+        end
+        cast_error(response) unless (response.status == 200 || response.status == 201)
+        return JSON.parse(response.body)
+    end
+
+    def cast_error(response)
+      message = response.body.empty? ? response.body : JSON.parse(response.body)['message']
+      error_map = {
+        500 => 'Sever error! Something were wrong in the server.',
+        400 => "Bad request!, #{ message }",
+        401 => 'Authentication error!',
+        402 => 'Required payment!',
+        403 => 'Restricted access!',
+        404 => 'Not found!',
+        405 => 'Operation does not allowed!',
+      }
+      raise StandardError, "Status: #{ response.status }. Error: #{ error_map[response.status] }"
+    end
+  end
+end

data/lib/alegra/setup.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+require 'json'
+require 'base64'
+
+module Alegra
+  class Setup
+    attr_accessor :host, :path, :apikey, :username, :debug, :token
+
+    def initialize(username=nil, apikey=nil, debug=false)
+      @host = 'https://app.alegra.com/'
+      @path = 'api/v1/'
+
+      @debug = debug
+
+      if not apikey
+        if ENV['ALEGRA_APIKEY']
+          @apikey = ENV['ALEGRA_APIKEY']
+        else
+          raise 'set up the ALEGRA_APIKEY environment variable'
+          # apikey = read_configs
+        end
+      end
+
+      if not username
+        if ENV['ALEGRA_USERNAME']
+          @username = ENV['ALEGRA_USERNAME']
+        else
+          raise 'set up the ALEGRA_USERNAME environment variable'
+          # apikey = read_configs
+        end
+      end
+
+      raise Error, 'You must provide a ALEGRA API key' if not apikey
+      raise Error, 'You must provide a ALEGRA USERNAME' if not username
+      @apikey = apikey
+      @username = username
+      create_token!
+    end
+
+    def create_token!
+      @token = ::Base64.encode64("#{@username}:#{@apikey}")
+    end
+  end
+end

data/lib/alegra/utilities/hash.rb

@@ -0,0 +1,22 @@
+class Hash
+  def deep_camel_case_lower_keys(hash=self)
+    {}.tap { |h|
+      hash.each { |key, value| h[transform_key(key)] = map_value(value) }
+    }
+  end
+
+  def map_value(thing)
+    case thing
+    when Hash
+      deep_camel_case_lower_keys(thing)
+    when Array
+      thing.map { |v| map_value(v) }
+    else
+      thing
+    end
+  end
+
+  def transform_key(key)
+    key.to_s.split('_').inject([]){ |buffer, e| buffer.push(buffer.empty? ? e : e.capitalize) }.join.to_sym
+  end
+end

data/lib/alegra/version.rb

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

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: alegra
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Diego Gomez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: jazz_fingers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Gem to wrap Alegra API. This is unofficial gem (until now)
+email:
+- diego.f.gomez.pardo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alegra.gemspec
+- bin/console
+- bin/setup
+- lib/alegra.rb
+- lib/alegra/client.rb
+- lib/alegra/contacts.rb
+- lib/alegra/invoices.rb
+- lib/alegra/request.rb
+- lib/alegra/setup.rb
+- lib/alegra/utilities/hash.rb
+- lib/alegra/version.rb
+homepage: https://github.com/degzcs/alegra
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Gem to wrap Alegra API.
+test_files: []