ynab 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d5c3660e4ee6926d6f04b16b52e101c39e484f1
+  data.tar.gz: db56f63929eef9af161c3f5a8082d769f7188805
+SHA512:
+  metadata.gz: bc89ce44f2eb367f2deef7fb1e6fd58c8733dd8c292c07fa953bec04f6d5cbe243f9c68cc684aa49642c7f99cd0fa03dfc0fe7f3e0782ccdc5cff200b73a9ebe
+  data.tar.gz: 8bab99f2fa6b4a25609f6979eee53e8dcf409c17cc9dba9b5f4800690ed6c06039579626e856198cbd453274afb32f9c97778c95c7412175e414989ef595a79a

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    ynab (0.1.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.21)
+    json (2.1.0)
+    rake (12.0.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  ynab!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 You Need A Budget, LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,57 @@
+# YNAB API Ruby Library
+
+[![Build Status](https://travis-ci.org/ynab/ynab-sdk-ruby.svg?branch=master)](https://travis-ci.org/ynab/ynab-sdk-ruby)
+[![NPM Package](https://img.shields.io/gem/v/ynab.svg)](https://rubygems.org/gems/ynab)
+
+**NOTE: The YNAB API is currently only available to Early Access users.  If you are interested in requesting access before the API is generally available, please fill out [this form](https://docs.google.com/forms/d/17plY-CE39Xl3pe2GqyVH1Unre8TjYKs-tkI6jVC4ko4/edit).**
+
+This is the Ruby client for the YNAB API.
+
+Please read the [YNAB API documentation](https://api.youneedabudget.com) for an
+overview of using the API and a complete list of available resources.
+
+This client is generated using the [Swagger Code Generator](https://github.com/swagger-api/swagger-codegen).
+
+## Installation
+
+```
+gem install ynab
+```
+
+## Usage
+
+To use this client you must
+[obtain an access token](https://api.youneedabudget.com/#authentication) from
+your [My Account](https://app.youneedabudget.com/settings) page of the YNAB web
+app.
+
+```ruby
+require 'ynab'
+
+access_token = 'bf0cbb14b4330-not-real-3de12e66a389eaafe2'
+
+ynab = YnabApi::Client.new(access_token)
+
+budget_response = ynab.budgets.get_budgets
+budgets = budget_response.data.budgets
+
+budgets.each do |budget|
+  puts "Budget Name: #{budget.name}"
+end
+```
+
+## Examples
+
+See the [examples folder](https://github.com/ynab/ynab-sdk-ruby/tree/master/examples) for, well, example usage scenarios.
+
+## Development
+
+- Install dependencies: `bundle`
+- Generate latest client based on swagger spec: `rake generate`
+- Run tests: `rake spec` or `rspec`
+
+## License
+
+Copyright (c) 2018 You Need A Budget, LLC
+
+Licensed under the Apache-2.0 license

data/Rakefile

@@ -0,0 +1,31 @@
+begin
+  require 'rspec/core/rake_task'
+  require 'bundler/gem_tasks'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = "-fd"
+  end
+rescue LoadError
+  # no rspec available
+end
+task :default => [:spec]
+
+desc "Run Swagger Code Generator to update the client from the Swagger spec"
+task :generate do
+  # Download latest swagger spec
+  spec_filename = 'spec-v1-swagger.json'
+  sh "rm #{spec_filename} && wget https://api.youneedabudget.com/papi/#{spec_filename}"
+
+  # Replace nullable types defined as i.e. ["string", "null"] in the spec to simply "string" as the generator does not understand the nullable format.
+  # Examples:
+  #   ["string", "null"] => "string"
+  #   ["number", "null"] => "number"
+  sh %Q[sed -E -i '' 's/\\\[\\"(string|number|array|boolean)\\"\\, \\"null\\"\\\]/"\\1"/g' #{spec_filename}]
+
+  # Use Docker to codegen ruby based on the swagger spec
+  sh "docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli generate"\
+     " -i /local/spec-v1-swagger.json"\
+     " -l ruby"\
+     " -c /local/config.json -o /local"\
+     " -t /local/swagger-templates"
+end

data/config.json

@@ -0,0 +1,10 @@
+{
+  "gemName": "ynab",
+  "moduleName": "YnabApi",
+  "gemVersion": "0.1.0",
+  "gemDescription": "Ruby gem wrapper for the YNAB API. Read the documentation at https://api.youneedabudget.com",
+  "gemHomepage": "https://github.com/ynab/ynab-sdk-ruby",
+  "gemLicense": "Apache-2.0",
+  "gemAuthor": "You Need A Budget, LLC",
+  "gemAuthorEmail": "help@youneedabudget.com"
+}

data/docs/Account.md

@@ -0,0 +1,16 @@
+# YnabApi::Account
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** |  | 
+**type** | **String** |  | 
+**on_budget** | **BOOLEAN** | Whether this account is on budget or not | 
+**closed** | **BOOLEAN** | Whether this account is closed or not | 
+**note** | **String** |  | 
+**balance** | **Float** | The current balance of the account in milliunits format | 
+**cleared_balance** | **Float** | The current cleared balance of the account in milliunits format | 
+**uncleared_balance** | **Float** | The current uncleared balance of the account in milliunits format | 
+
+

data/docs/AccountResponse.md

@@ -0,0 +1,8 @@
+# YnabApi::AccountResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**AccountWrapper**](AccountWrapper.md) |  | 
+
+

data/docs/AccountWrapper.md

@@ -0,0 +1,8 @@
+# YnabApi::AccountWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account** | [**Account**](Account.md) |  | 
+
+

data/docs/AccountsApi.md

@@ -0,0 +1,121 @@
+# YnabApi::AccountsApi
+
+All URIs are relative to *https://api.youneedabudget.com/papi/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_account_by_id**](AccountsApi.md#get_account_by_id) | **GET** /budgets/{budget_id}/accounts/{account_id} | Single account
+[**get_accounts**](AccountsApi.md#get_accounts) | **GET** /budgets/{budget_id}/accounts | Account list
+
+
+# **get_account_by_id**
+> AccountResponse get_account_by_id(budget_id, account_id)
+
+Single account
+
+Returns a single account
+
+### Example
+```ruby
+# load the gem
+require 'ynab'
+# setup authorization
+YnabApi.configure do |config|
+  # Configure API key authorization: bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = YnabApi::AccountsApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+account_id = "account_id_example" # String | The ID of the Account.
+
+
+begin
+  #Single account
+  result = api_instance.get_account_by_id(budget_id, account_id)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling AccountsApi->get_account_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+ **account_id** | [**String**](.md)| The ID of the Account. | 
+
+### Return type
+
+[**AccountResponse**](AccountResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_accounts**
+> AccountsResponse get_accounts(budget_id)
+
+Account list
+
+Returns all accounts
+
+### Example
+```ruby
+# load the gem
+require 'ynab'
+# setup authorization
+YnabApi.configure do |config|
+  # Configure API key authorization: bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = YnabApi::AccountsApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+
+begin
+  #Account list
+  result = api_instance.get_accounts(budget_id)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling AccountsApi->get_accounts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+
+### Return type
+
+[**AccountsResponse**](AccountsResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+