nusii 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03c6d3347ec4b9e09b5ccd2e2efc2ba4aa1a3311641acce82aebaf1f3b699960
+  data.tar.gz: f57f750cafed39f795bcbb588062993536d4bd70c455e25b3685c62b9d1ef4d7
+SHA512:
+  metadata.gz: 15d7ac2715ed3cda572f48550628feb58d152a1c2b8b722c2c9b64999d354b9d56e5b97b5fc32c48b18a929a0b3e91d1e0a5b8b82c8a6035a27e1459002537ea
+  data.tar.gz: 3e9c10b362c22bfddec18612c7b811fa7df47489e019e350ce0cdc028d42b8a89a7ad3f593839588405a0e08d7af3c6a41dbbf3a7162f0bdc203ac1dd29b07e1

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.ruby-version

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+  - 2.2
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'pry'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Nusii
+
+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,306 @@
+[![Build Status](https://travis-ci.org/Nusii/nusii-ruby.png)](https://travis-ci.org/Nusii/nusii-ruby)
+
+# Nusii
+
+Ruby library for the [Nusii API](https://developer.nusii.com)
+
+## Table of contents
+
+  * [Installation](#installation)
+  * [Setup](#setup)
+  * [Example usage](#example-usage)
+  * [Available methods by resource](#available-methods-by-resource)
+  * [Contributing](#contributing)
+  * [Usage](#contributing)
+
+## Installation
+
+To get the latest stable, add this to your Gemfile:
+
+    gem 'nusii'
+
+To get the latest code, add this:
+
+    gem 'nusii', git: https://github.com/Nusii/nusii-ruby
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nusii
+
+## Setup
+
+The only thing you need to do is add you API KEY:
+
+```ruby
+require 'nusii-ruby'
+
+Nusii.setup(:api_key => 'YOUR_API_KEY', :user_agent => 'your_user_agent')
+```
+
+## Example usage
+
+### Listing resources
+
+Use .list to retrieve a list of a resource
+
+```ruby
+> Nusii::Client.list
+=> #<Nusii::ResponseObject:0x007fadfb6d8ac0
+ @meta={"current_page"=>1, "next_page"=>2, "prev_page"=>nil, "total_pages"=>2, "total_count"=>29},
+ @resource_class=Nusii::Client,
+ @resources=
+  [#<Nusii::Client:0x007fadfb6eb468
+    @currency="USD",
+    @email="martin@madeupcompany.com",
+    @full_name="Martin",
+    @id=35843,
+    @locale="en",
+    @name="Martin",
+    @pdf_page_size="A4">,
+    ... ]
+```
+
+You can also pass options such as `page` or `per`:
+
+```ruby
+> Nusii::Client.list(:per => 2, :page => 4)
+=> #<Nusii::ResponseObject:0x007fadfb530c40
+ @meta={"current_page"=>4, "next_page"=>5, "prev_page"=>3, "total_pages"=>15, "total_count"=>29},
+ @resource_class=Nusii::Client,
+ @resources=
+  [#<Nusii::Client:0x007fadfb5313c0
+    @currency="USD",
+    @email="victor@madeupcompany.com",
+    @full_name="Victor",
+    @id=35835,
+    @locale="es",
+    @name="Victor",
+    @pdf_page_size="A4">,
+   #<Nusii::Client:0x007fadfb530e20
+    @currency="EUR",
+    @email="altheasmith@madeupcompany.com",
+    @full_name="Althea",
+    @id=35834,
+    @locale="en",
+    @name="Althea",
+    @pdf_page_size="A4">]>
+```
+
+
+Any ResponseObject instance also has the methods `next_page` and `prev_page` which will automatically make the requests based on the current search.
+
+```ruby
+> response = Nusii::Client.list(:per => 4, :page => 2)
+=> #<Nusii::ResponseObject:0x007fadfb0bd028
+ @meta={"current_page"=>2, "next_page"=>3, "prev_page"=>1, "total_pages"=>8, "total_count"=>29},
+ @resource_class=Nusii::Client,
+ @resources= [...]
+
+> response.prev_page
+=> #<Nusii::ResponseObject:0x007f8df2c3b518
+ @meta={"current_page"=>1, "next_page"=>2, "prev_page"=>nil, "total_pages"=>8, "total_count"=>29},
+ @resource_class=Nusii::Client,
+ @resources=[...]
+```
+
+`Nusii::ListItem` has also a method called `.list_by_section` that accepts a `section_id` as the first argument and retrieves ListItems under that section_id
+
+### Getting a single resource
+
+Use `.get` to retrieve a single resource
+
+```ruby
+> Nusii::Section.get 309405
+=> #<Nusii::Section:0x007f8df3020778
+ @id=309405,
+ @body=
+  "<p>We are a web design studio with offices in Madrid and Barcelona and we're lucky enough to work with people from all over the world./p>",
+ @currency="EUR",
+ @include_total=false,
+ @name="Introduction",
+ ...">
+```
+
+### Creating and updating resources
+
+You can create a resource with the class method `.create` by passing a hash of arguments:
+
+```ruby
+> Nusii::Client.create({:name => 'Laura Palmer', :email => 'laura.palmer@tphs.com'})
+=> #<Nusii::Client:0x007f8df2b6aa58
+ @currency="USD",
+ @email="laura.palmer@tphs.com",
+ @full_name="Laura Palmer",
+ @id=35947,
+ @locale="en",
+ @name="Laura Palmer",
+ @pdf_page_size="A4">
+```
+
+You can also create them by using `#save` on a new object:
+
+```ruby
+client = Nusii::Client.new({:name => 'Laura Palmer', :email => 'laura.palmer@tphs.com'})
+=> #<Nusii::Client:0x007f8df2b226e0 @email="laura.palmer@tphs.com", @name="Laura Palmer">
+> client.save
+=> #<Nusii::Client:0x007f8df2abacc0
+ @currency="USD",
+ @email="laura.palmer@tphs.com",
+ @full_name="Laura Palmer",
+ @id=35948,
+ @locale="en",
+ @name="Laura Palmer",
+ @pdf_page_size="A4">
+```
+
+Any resource with a valid `id` value can be updated with the same method, `#save`.
+
+```ruby
+> client.name = 'Sheryl Lee'
+=> "Sheryl Lee"
+> client.save
+=> #<Nusii::Client:0x007f8df21521b0
+ @currency="USD",
+ @email="laura.palmer@tphs.com",
+ @full_name="Sheryl Lee",
+ @id=35949,
+ @locale="en",
+ @name="Sheryl Lee",
+ @pdf_page_size="A4">
+```
+
+### Deleting resources
+
+Just as happens with creation, a resource can be deleted by a class method `.destroy` passign a valid id or with `#destroy` on a instance.
+
+```ruby
+> Nusii::WebhookEndpoint.destroy(54)
+=> true
+```
+
+```ruby
+> webhook = Nusii::WebhookEndpoint.get(55)
+=> #<Nusii::WebhookEndpoint:0x007f8df2302a28 @events=["proposal_updated"], @id=55, @target_url="http://example.com">
+> webhook.destroy
+=> true
+```
+
+### Sending a proposal
+
+With any `Proposal` object you can use the method `#send_proposal`. You need to pass at least the email of the client you want the existing proposal sent to. Please [refer to the API](https://developer.nusii.com/#send-a-proposal) for more information.
+
+```ruby
+> proposal.send_proposal(:email => 'lucas.tazmily@myclient.com')
+=> {"status"=>"pending", "sent_at"=>"2017-12-11T12:37:12.593Z", "sent_at_in_ms"=>1512995832000, "sender_id"=>nil, "sender_name"=>nil}
+```
+
+### Retrieving account information
+
+Use `Account.me` to get the information from your account
+
+```ruby
+> Nusii::Account.me
+=> #<Nusii::Account:0x007fb042f30350
+ @address="Calle Mayor, 23",
+ @city="Madrid",
+ @country="Spain",
+ @country_name="Spain",
+ @currency="EUR",
+ @email="michael@test.com",
+ @id=44,
+ @name="Michael Account",
+ @postcode="28017",
+ @subdomain="michael",
+ @telephone="123456789",
+ @web="nusii.com">
+```
+
+### Rate limiting
+
+There is a rate limit in Nusii API of 100 requests every 30 seconds. After every request, a class variable in `Nusii` will get updated so you can check if you are reaching the limit
+
+```ruby
+> Nusii.rate_limit_remaining
+=> 98
+> Nusii::Account.me
+=> #<Nusii::Account:0x007f8df20fa028 ...>
+> Nusii.rate_limit_remaining
+=> 97
+```
+
+There's another variable called `rate_limit_retry_after` that will store the amount of time, in seconds, that you have to wait if you have reached the limit.
+
+## Available methods by resource
+
+#### Account
+
+* Nusii::Account.me
+
+#### Clients
+
+* Nusii::Client.list
+* Nusii::Client.get
+* Nusii::Client.create
+* Nusii::Client#save
+* Nusii::Client.destroy
+* Nusii::Client#destroy
+
+#### Sections
+
+* Nusii::Section.list
+* Nusii::Section.get
+* Nusii::Section.create
+* Nusii::Section#save
+* Nusii::Section.destroy
+* Nusii::Section#destroy
+
+#### Line Items
+
+* Nusii::LineItem.list
+* Nusii::LineItem.list_by_section
+* Nusii::LineItem.create_with_section
+* Nusii::LineItem#save
+* Nusii::LineItem.destroy
+* Nusii::LineItem#destroy
+
+#### Proposals
+
+* Nusii::Proposal.list
+* Nusii::Proposal.get
+* Nusii::Proposal.create
+* Nusii::Proposal#save
+* Nusii::Proposal.destroy
+* Nusii::Proposal#destroy
+* Nusii::Proposal#send_proposal
+
+#### Proposal Activities
+
+* Nusii::Proposal.list
+* Nusii::Proposal.get
+
+#### Webhook Enpoints
+
+* Nusii::WebhookEndpoint.list
+* Nusii::WebhookEndpoint.get
+* Nusii::WebhookEndpoint.create
+* Nusii::WebhookEndpoint#save
+* Nusii::WebhookEndpoint.destroy
+* Nusii::WebhookEndpoint#destroy
+
+## Contributing
+
+If you want to contribute, please follow these easy steps:
+
+1. Fork it ( http://github.com/nusii/nusii-ruby/fork )
+2. Create your feature branch (`git checkout -b improving-something`)
+3. Commit your changes (`git commit -am 'Let's improve this!'`)
+4. Push to the branch (`git push origin improving-something`)
+5. Create new Pull Request
+
+## License
+
+Released under the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nusii"
+
+require "pry"
+Pry.start

data/lib/nusii.rb

@@ -0,0 +1,54 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/blank'
+require 'active_support/inflector'
+require 'faraday'
+require 'json'
+require 'pry'
+
+require "nusii/version"
+
+require 'nusii/api_operations/connection'
+require 'nusii/api_operations/base'
+require 'nusii/api_operations/show'
+require 'nusii/api_operations/index'
+require 'nusii/api_operations/nested_index'
+require 'nusii/api_operations/create'
+require 'nusii/api_operations/nested_create'
+require 'nusii/api_operations/update'
+require 'nusii/api_operations/delete'
+require 'nusii/api_operations/send'
+
+require 'nusii/crud/get'
+require 'nusii/crud/list'
+require 'nusii/crud/create'
+require 'nusii/crud/save'
+require 'nusii/crud/destroy'
+require 'nusii/crud/destroy_self'
+
+require 'nusii/utils/json_api_builder'
+
+require 'nusii/nusii_error'
+require 'nusii/request'
+require 'nusii/response_object'
+require 'nusii/resource'
+require 'nusii/account'
+require 'nusii/client'
+require 'nusii/line_item'
+require 'nusii/proposal'
+require 'nusii/proposal_activity'
+require 'nusii/section'
+require 'nusii/webhook_endpoint'
+
+module Nusii
+  extend self
+
+  class << self
+    attr_accessor :api_key, :user_agent,
+                  :rate_limit_remaining, :rate_limit_retry_after
+
+    def setup params
+      @api_key     = params[:api_key]
+      @user_agent  = params[:user_agent]
+    end
+  end
+end

data/lib/nusii/account.rb

@@ -0,0 +1,18 @@
+module Nusii
+  class Account < Resource
+
+    attr_reader :id, :email, :name, :subdomain, :web, :currency,
+                :pdf_page_size, :locale, :address, :address_state,
+                :postcode, :city, :telephone, :default_theme
+
+    def self.me
+      requester = Nusii::Request.new
+      requester.show_call self
+    end
+
+    def self.resource_path
+      "/api/v2/account/me"
+    end
+
+  end
+end