ynab 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a4d3a0740b445b4056dd6bf489c6ab83c0941c6
-  data.tar.gz: 04e4894f4d8f7ade62afc56ac7057b915bba3c9d
+  metadata.gz: 0db932ecbce95c269779a53c4afaa25ae46d2f79
+  data.tar.gz: f23014b51453a6aef7924f53009c9515b7ecf0b4
 SHA512:
-  metadata.gz: aa657ced871b1463e5db24f599d657f575bd4a50c3932a021ae761540dfc239af1619acff5953c9afd910e873b715819122947c0ac1ffdea13ee8891736c056d
-  data.tar.gz: 8c8fd058f98c7f954f7a87320b4f2f055ab6841224d8ee821ac703837689e55879c0a91b2ad722c258dfe1fdf2f2242df25b6128f19969ea728299751722ddb0
+  metadata.gz: 1d466d8f2ac544eaa865aa955c259db885f0ac04cd75d6b8a8c3e2f9e5d2603a62cdb1008124743241494246de875441c5c856714e3bfa8f9fa8554f47f4643d
+  data.tar.gz: 91d206caa1621b865fba3dfad82be870c51ca08c30ce6138690fe8ecce61463df2aacdabee0fe80536be6a1a5d4684948c54f9cb692b8f06124af37fb8843424

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ynab (1.2.0)
+    ynab (1.3.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/README.md

@@ -78,7 +78,7 @@ The following methods are available in this library.
 - Install dependencies: `bundle`
 - Generate latest client based on swagger spec: `rake generate`
 - Run tests: `rake spec` or `rspec`
-- Publish: Bump `gemVersion` in config.json and then run `rake publish`
+- Publish to RubyGems: Bump `gemVersion` in config.json and then run `rake publish`
 
 ## License
 

data/Rakefile

@@ -36,5 +36,5 @@ task :commit_version_bump do
 end
 
 desc "Bump version, run specs build a gem and release on RubyGems"
-task :publish => ['generate', 'spec', 'release']
+task :publish => ['generate', 'commit_version_bump', 'spec', 'release']
 

data/config.json

@@ -1,7 +1,7 @@
 {
   "gemName": "ynab",
   "moduleName": "YNAB",
-  "gemVersion": "1.2.0",
+  "gemVersion": "1.3.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",

data/docs/MonthDetail.md

@@ -5,8 +5,11 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **month** | **Date** |  | 
 **note** | **String** |  | 
-**to_be_budgeted** | **Integer** | The current balance of the account in milliunits format | 
-**age_of_money** | **Integer** |  | 
+**income** | **Integer** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month | 
+**budgeted** | **Integer** | The total amount budgeted in the month | 
+**activity** | **Integer** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' | 
+**to_be_budgeted** | **Integer** | The available amount for 'To be Budgeted' | 
+**age_of_money** | **Integer** | The Age of Money as of the month | 
 **categories** | [**Array<Category>**](Category.md) | The budget month categories | 
 
 

data/docs/MonthSummary.md

@@ -5,7 +5,10 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **month** | **Date** |  | 
 **note** | **String** |  | 
-**to_be_budgeted** | **Integer** | The current balance of the account in milliunits format | 
-**age_of_money** | **Integer** |  | 
+**income** | **Integer** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month | 
+**budgeted** | **Integer** | The total amount budgeted in the month | 
+**activity** | **Integer** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' | 
+**to_be_budgeted** | **Integer** | The available amount for 'To be Budgeted' | 
+**age_of_money** | **Integer** | The Age of Money as of the month | 
 
 

data/docs/MonthsApi.md

@@ -20,7 +20,7 @@ Returns a single budget month
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **budget_id** | [**String**](.md)| The ID of the Budget. | 
- **month** | **Date**| The Budget Month.  \"current\" can also be used to specify the current calendar month (UTC). | 
+ **month** | **Date**| The Budget Month in ISO format (e.g. 2016-12-01).    \"current\" can also be used to specify the current calendar month (UTC). | 
 
 ### Return type
 

data/examples/budget-list.rb

@@ -1,4 +1,3 @@
-$:.unshift('../lib')
 require 'ynab'
 
 def print_budget_list
@@ -22,4 +21,4 @@ def print_budget_list
   end
 end
 
-print_budget_list()
+print_budget_list

data/examples/budget-month.rb

@@ -1,4 +1,3 @@
-$:.unshift('../lib')
 require 'ynab'
 require 'date'
 
@@ -33,4 +32,4 @@ def print_budget_month
   end
 end
 
-print_budget_month()
+print_budget_month

data/examples/category-balance.rb

@@ -1,4 +1,3 @@
-$:.unshift('../lib')
 require 'ynab'
 
 def print_category_info
@@ -24,4 +23,4 @@ def print_category_info
   end
 end
 
-print_category_info()
+print_category_info

data/examples/create-transaction.rb

@@ -0,0 +1,31 @@
+require 'date'
+require 'ynab'
+
+def create_transaction
+  access_token = 'bf0cbb14b4330-not-real-3de12e66a389eaafe2'
+  ynab = YNAB::API.new(access_token)
+
+  budget_id = 'f968197b-2863-not-real-c2406dbe7f0d'
+  account_id = 'f6fe07cb-c895-not-real-acfac0b7f026'
+  category_id = 'a191ac84-de09-not-real-6c5ed8cfdabe'
+
+  begin
+    ynab.transactions.create_transaction(budget_id, {
+      transaction: {
+        account_id: account_id,
+        category_id: category_id,
+        date: Date.today,
+        payee_name: 'A Test Payee',
+        memo: 'I was created through the API',
+        cleared: 'Cleared',
+        approved: true,
+        flag_color: 'Blue',
+        amount: 20000
+      }
+    })
+  rescue => e
+    puts "ERROR: id=#{e.id}; name=#{e.name}; detail: #{e.detail}"
+  end
+end
+
+create_transaction

data/lib/ynab/api/months_api.rb

@@ -22,7 +22,7 @@ module YNAB
     # Single budget month
     # Returns a single budget month
     # @param budget_id The ID of the Budget.
-    # @param month The Budget Month.  \"current\" can also be used to specify the current calendar month (UTC).
+    # @param month The Budget Month in ISO format (e.g. 2016-12-01).    \"current\" can also be used to specify the current calendar month (UTC).
     # @param [Hash] opts the optional parameters
     # @return [MonthDetailResponse]
     def get_budget_month(budget_id, month, opts = {})
@@ -33,7 +33,7 @@ module YNAB
     # Single budget month
     # Returns a single budget month
     # @param budget_id The ID of the Budget.
-    # @param month The Budget Month.  \"current\" can also be used to specify the current calendar month (UTC).
+    # @param month The Budget Month in ISO format (e.g. 2016-12-01).    \"current\" can also be used to specify the current calendar month (UTC).
     # @param [Hash] opts the optional parameters
     # @return [Array<(MonthDetailResponse, Fixnum, Hash)>] MonthDetailResponse data, response status code and response headers
     def get_budget_month_with_http_info(budget_id, month, opts = {})

data/lib/ynab/api_error.rb

@@ -27,12 +27,38 @@ module YNAB
           super arg
         end
 
-        arg.each do |k, v|
-          instance_variable_set "@#{k}", v
+        arg.each do |key, value|
+          if respond_to?("#{key}=")
+            send "#{key}=", value
+          else
+            instance_variable_set "@#{key}", value
+          end
         end
       else
         super arg
       end
     end
+
+    def response_body=(value)
+      @response_body = value
+
+      begin
+        @error_parsed = JSON.parse(value)
+      rescue
+        @error_parsed = nil
+      end
+    end
+
+    def id
+      (@error_parsed || {}).fetch('error', {})['id']
+    end
+
+    def name
+      (@error_parsed || {}).fetch('error', {})['name']
+    end
+
+    def detail
+      (@error_parsed || {}).fetch('error', {})['detail']
+    end
   end
 end

data/lib/ynab/models/month_detail.rb

@@ -18,9 +18,19 @@ module YNAB
 
     attr_accessor :note
 
-    # The current balance of the account in milliunits format
+    # The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month
+    attr_accessor :income
+
+    # The total amount budgeted in the month
+    attr_accessor :budgeted
+
+    # The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted'
+    attr_accessor :activity
+
+    # The available amount for 'To be Budgeted'
     attr_accessor :to_be_budgeted
 
+    # The Age of Money as of the month
     attr_accessor :age_of_money
 
     # The budget month categories
@@ -31,6 +41,9 @@ module YNAB
       {
         :'month' => :'month',
         :'note' => :'note',
+        :'income' => :'income',
+        :'budgeted' => :'budgeted',
+        :'activity' => :'activity',
         :'to_be_budgeted' => :'to_be_budgeted',
         :'age_of_money' => :'age_of_money',
         :'categories' => :'categories'
@@ -42,6 +55,9 @@ module YNAB
       {
         :'month' => :'Date',
         :'note' => :'String',
+        :'income' => :'Integer',
+        :'budgeted' => :'Integer',
+        :'activity' => :'Integer',
         :'to_be_budgeted' => :'Integer',
         :'age_of_money' => :'Integer',
         :'categories' => :'Array<Category>'
@@ -64,6 +80,18 @@ module YNAB
         self.note = attributes[:'note']
       end
 
+      if attributes.has_key?(:'income')
+        self.income = attributes[:'income']
+      end
+
+      if attributes.has_key?(:'budgeted')
+        self.budgeted = attributes[:'budgeted']
+      end
+
+      if attributes.has_key?(:'activity')
+        self.activity = attributes[:'activity']
+      end
+
       if attributes.has_key?(:'to_be_budgeted')
         self.to_be_budgeted = attributes[:'to_be_budgeted']
       end
@@ -91,6 +119,18 @@ module YNAB
         invalid_properties.push('invalid value for "note", note cannot be nil.')
       end
 
+      if @income.nil?
+        invalid_properties.push('invalid value for "income", income cannot be nil.')
+      end
+
+      if @budgeted.nil?
+        invalid_properties.push('invalid value for "budgeted", budgeted cannot be nil.')
+      end
+
+      if @activity.nil?
+        invalid_properties.push('invalid value for "activity", activity cannot be nil.')
+      end
+
       if @to_be_budgeted.nil?
         invalid_properties.push('invalid value for "to_be_budgeted", to_be_budgeted cannot be nil.')
       end
@@ -111,6 +151,9 @@ module YNAB
     def valid?
       return false if @month.nil?
       return false if @note.nil?
+      return false if @income.nil?
+      return false if @budgeted.nil?
+      return false if @activity.nil?
       return false if @to_be_budgeted.nil?
       return false if @age_of_money.nil?
       return false if @categories.nil?
@@ -124,6 +167,9 @@ module YNAB
       self.class == o.class &&
           month == o.month &&
           note == o.note &&
+          income == o.income &&
+          budgeted == o.budgeted &&
+          activity == o.activity &&
           to_be_budgeted == o.to_be_budgeted &&
           age_of_money == o.age_of_money &&
           categories == o.categories
@@ -138,7 +184,7 @@ module YNAB
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [month, note, to_be_budgeted, age_of_money, categories].hash
+      [month, note, income, budgeted, activity, to_be_budgeted, age_of_money, categories].hash
     end
 
     # Builds the object from hash

data/lib/ynab/models/month_summary.rb

@@ -18,9 +18,19 @@ module YNAB
 
     attr_accessor :note
 
-    # The current balance of the account in milliunits format
+    # The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month
+    attr_accessor :income
+
+    # The total amount budgeted in the month
+    attr_accessor :budgeted
+
+    # The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted'
+    attr_accessor :activity
+
+    # The available amount for 'To be Budgeted'
     attr_accessor :to_be_budgeted
 
+    # The Age of Money as of the month
     attr_accessor :age_of_money
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -28,6 +38,9 @@ module YNAB
       {
         :'month' => :'month',
         :'note' => :'note',
+        :'income' => :'income',
+        :'budgeted' => :'budgeted',
+        :'activity' => :'activity',
         :'to_be_budgeted' => :'to_be_budgeted',
         :'age_of_money' => :'age_of_money'
       }
@@ -38,6 +51,9 @@ module YNAB
       {
         :'month' => :'Date',
         :'note' => :'String',
+        :'income' => :'Integer',
+        :'budgeted' => :'Integer',
+        :'activity' => :'Integer',
         :'to_be_budgeted' => :'Integer',
         :'age_of_money' => :'Integer'
       }
@@ -59,6 +75,18 @@ module YNAB
         self.note = attributes[:'note']
       end
 
+      if attributes.has_key?(:'income')
+        self.income = attributes[:'income']
+      end
+
+      if attributes.has_key?(:'budgeted')
+        self.budgeted = attributes[:'budgeted']
+      end
+
+      if attributes.has_key?(:'activity')
+        self.activity = attributes[:'activity']
+      end
+
       if attributes.has_key?(:'to_be_budgeted')
         self.to_be_budgeted = attributes[:'to_be_budgeted']
       end
@@ -80,6 +108,18 @@ module YNAB
         invalid_properties.push('invalid value for "note", note cannot be nil.')
       end
 
+      if @income.nil?
+        invalid_properties.push('invalid value for "income", income cannot be nil.')
+      end
+
+      if @budgeted.nil?
+        invalid_properties.push('invalid value for "budgeted", budgeted cannot be nil.')
+      end
+
+      if @activity.nil?
+        invalid_properties.push('invalid value for "activity", activity cannot be nil.')
+      end
+
       if @to_be_budgeted.nil?
         invalid_properties.push('invalid value for "to_be_budgeted", to_be_budgeted cannot be nil.')
       end
@@ -96,6 +136,9 @@ module YNAB
     def valid?
       return false if @month.nil?
       return false if @note.nil?
+      return false if @income.nil?
+      return false if @budgeted.nil?
+      return false if @activity.nil?
       return false if @to_be_budgeted.nil?
       return false if @age_of_money.nil?
       true
@@ -108,6 +151,9 @@ module YNAB
       self.class == o.class &&
           month == o.month &&
           note == o.note &&
+          income == o.income &&
+          budgeted == o.budgeted &&
+          activity == o.activity &&
           to_be_budgeted == o.to_be_budgeted &&
           age_of_money == o.age_of_money
     end
@@ -121,7 +167,7 @@ module YNAB
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [month, note, to_be_budgeted, age_of_money].hash
+      [month, note, income, budgeted, activity, to_be_budgeted, age_of_money].hash
     end
 
     # Builds the object from hash

data/lib/ynab/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 =end
 
 module YNAB
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/spec-v1-swagger.json

@@ -644,7 +644,7 @@
             "name": "month",
             "in": "path",
             "description":
-              "The Budget Month.  \"current\" can also be used to specify the current calendar month (UTC).",
+              "The Budget Month in ISO format (e.g. 2016-12-01).    \"current\" can also be used to specify the current calendar month (UTC).",
             "required": true,
             "type": "string",
             "format": "date"
@@ -764,6 +764,12 @@
             "schema": {
               "$ref": "#/definitions/ErrorResponse"
             }
+          },
+          "409": {
+            "description": "A transaction on the same account with the same import_id already exists.",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            }
           }
         }
       }
@@ -2492,7 +2498,7 @@
     },
     "MonthSummary": {
       "type": "object",
-      "required": ["month", "note", "to_be_budgeted", "age_of_money"],
+      "required": ["month", "note", "income", "budgeted", "activity", "to_be_budgeted", "age_of_money"],
       "properties": {
         "month": {
           "type": "string",
@@ -2501,14 +2507,33 @@
         "note": {
           "type": "string"
         },
+        "income": {
+          "type": "integer",
+          "format": "1234000",
+          "description":
+            "The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month"
+        },
+        "budgeted": {
+          "type": "integer",
+          "format": "1234000",
+          "description":
+            "The total amount budgeted in the month"
+        },
+        "activity": {
+          "type": "integer",
+          "format": "1234000",
+          "description":
+            "The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted'"
+        },
         "to_be_budgeted": {
           "type": "integer",
           "format": "1234000",
           "description":
-            "The current balance of the account in milliunits format"
+            "The available amount for 'To be Budgeted'"
         },
         "age_of_money": {
-          "type": "integer"
+          "type": "integer",
+          "description": "The Age of Money as of the month"
         }
       }
     },

data/spec/api_error_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'APIError' do
+  it 'should parse error correctly' do
+    response_body = '{"error":{"id":"401","name":"unauthorized","detail":"Unauthorized"}}'
+    error = YNAB::ApiError.new({ code: 400, response_headers: nil, response_body: response_body })
+    expect(error.code).to eq 400
+    expect(error.response_body).to eq response_body
+
+    expect(error.id).to eq '401'
+    expect(error.name).to eq 'unauthorized'
+    expect(error.detail).to eq 'Unauthorized'
+  end
+
+  it 'should gracefully handle an unparsable error' do
+    response_body = '{"strange_object":{"key":"an_interesting_key"}}'
+    error = YNAB::ApiError.new({ code: 201, response_headers: nil, response_body: response_body })
+    expect(error.code).to eq 201
+    expect(error.response_body).to eq response_body
+
+    expect(error.id).to_not be
+    expect(error.name).to_not be
+    expect(error.detail).to_not be
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ynab
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - You Need A Budget, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-18 00:00:00.000000000 Z
+date: 2018-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -184,6 +184,7 @@ files:
 - examples/budget-list.rb
 - examples/budget-month.rb
 - examples/category-balance.rb
+- examples/create-transaction.rb
 - lib/ynab.rb
 - lib/ynab/api/accounts_api.rb
 - lib/ynab/api/budgets_api.rb
@@ -269,7 +270,7 @@ files:
 - lib/ynab/version.rb
 - pkg/ynab-1.0.0.gem
 - pkg/ynab-1.1.0.gem
-- pkg/ynab-1.2.0.gem
+- pkg/ynab-1.3.0.gem
 - spec-v1-swagger.json
 - spec/api/accounts_spec.rb
 - spec/api/budgets_spec.rb
@@ -279,6 +280,7 @@ files:
 - spec/api/payees_spec.rb
 - spec/api/scheduled_transactions_spec.rb
 - spec/api/transactions_spec.rb
+- spec/api_error_spec.rb
 - spec/fixtures/.DS_Store
 - spec/fixtures/vcr_cassettes/account.yml
 - spec/fixtures/vcr_cassettes/accounts.yml
@@ -348,6 +350,7 @@ test_files:
 - spec/api/budgets_spec.rb
 - spec/api/months_spec.rb
 - spec/api/transactions_spec.rb
+- spec/api_error_spec.rb
 - spec/fixtures/.DS_Store
 - spec/fixtures/vcr_cassettes/payee_transactions.yml
 - spec/fixtures/vcr_cassettes/categories.yml