lunchmoney 0.10.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0eee6d8599ca3bcc3937bff5208db6a4502029ed711940ffbe90e807c4b0bd1
-  data.tar.gz: e8f7d58fbf604cf59c60111963c063273f04b7bab3e7d3ddf1e0684213cab1d2
+  metadata.gz: 66fd4ba45ca3d30c32dea0c70f504714811980af2bf373b2412232da5e9d19da
+  data.tar.gz: 1a2becc26568423ff1b6fa70108400efa5cc366cd65e1ced013eb34084c65dee
 SHA512:
-  metadata.gz: a6a0af1c49bac3eccbaaa802dc7c4d9c59122083e69ae19efdeda3bf322e3f5c290b1f207d4805cc4b9fcff62ae317fb2249cd2340ce3186fef0b930b9132a20
-  data.tar.gz: 971503cc33d3bec22fc0e643141d85d49ba5a5295fc85f2f7e3d37f40216c57368f05e394293a86184f6052696c9aed1efc58104b177c5614194b8b3a970dcd5
+  metadata.gz: 5a3a997026a7ab6c541ef0cb4c8b1fb6fcf992ad91d2ae6cc1ba408007f88a7a001cb9703d7c15038f4ce87fa36d78a9580b4cd5010e3a36a747c4845ce5e96b
+  data.tar.gz: 3a4c3ec3283535b9829afd17427f89e7f88538826b4c30f02075e13807e925fac9070d90f9061ea7ec6cc8f135099dc43623929f83a322a48c987644083931d7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lunchmoney (0.10.0)
+    lunchmoney (1.0.0)
       activesupport (>= 6.1)
       faraday (>= 1.0.0)
       sorbet-runtime (>= 0.5)

data/README.md

@@ -1,10 +1,12 @@
 # lunchmoney
 
-This gem and readme are very much a work in progress. More to come!
+[![Gem Version](https://badge.fury.io/rb/lunchmoney.svg)](https://badge.fury.io/rb/lunchmoney)
+[![CI](https://github.com/halorrr/lunchmoney/actions/workflows/ci.yml/badge.svg)](https://github.com/halorrr/lunchmoney/actions/workflows/ci.yml)
+[![Yard Docs](https://github.com/halorrr/lunchmoney/actions/workflows/build_and_publish_yard_docs.yml/badge.svg)](https://github.com/halorrr/lunchmoney/actions/workflows/build_and_publish_yard_docs.yml)
 
-This gem is a library of the [LunchMoney API](https://lunchmoney.dev/) for the wonderful [LunchMoney](http://lunchmoney.app/) web app for personal finance & budgeting.
+This gem is a API client library of the [LunchMoney API](https://lunchmoney.dev/) for the wonderful [LunchMoney](http://lunchmoney.app/) web app for personal finance & budgeting.
 
-You can find the yard docs for this gem [here](https://halorrr.github.io/lunchmoney/)
+Documentation is still a work in process, but you can find the yard docs for this gem [here](https://halorrr.github.io/lunchmoney/) as well as some write ups of the basics below.
 
 ## Usage
 
@@ -36,13 +38,48 @@ LunchMoney::Api.new(api_key: "your_api_key")
 
 ### Using the API
 
-Create an instance of the api, then call the endpoint you need:
+It is intended that all calls typically go through a `LunchMoney::Api` instannce. This class delegates methods to their
+relvant classes behind the scenes. Create an instance of the api, then call the endpoint you need:
 
 ```Ruby
 api = LunchMoney::Api.new
 api.categories
 ```
 
+When the api returns an error a `LunchMoney::Errors` object will be returned. You can check the errors that occured via
+`.messages` on the instance. This will return an array of errors.
+
+```Ruby
+api = LunchMoney::Api.new
+response = api.categories
+
+response.class
+=> LunchMoney::Errors
+
+response.messages
+=> ["Some error returned by the API"]
+```
+
+The instance itself has been set up to act like an array, delegating a lot of common array getter methods directly to
+messages for you. This enables things like:
+
+```Ruby
+api = LunchMoney::Api.new
+response = api.categories
+
+response.class
+=> LunchMoney::Errors
+
+response.first
+=> "Some error returned by the API"
+
+response.empty?
+=> false
+
+response[0]
+=> "Some error returned by the API"
+```
+
 ## Contributing to this repo
 
 Feel free to contribute and submit PRs to improve this gem

data/lib/lunchmoney/version.rb

@@ -3,5 +3,5 @@
 
 module LunchMoney
   # Current version of the gem
-  VERSION = "0.10.0"
+  VERSION = "1.0.0"
 end

data/lunchmoney.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata["allowed_push_host"]  = "https://rubygems.org"
   spec.metadata["homepage_uri"]       = spec.homepage
   spec.metadata["source_code_uri"]    = spec.homepage
+  spec.metadata["documentation_uri"]  = "https://halorrr.github.io/lunchmoney/"
   spec.metadata["changelog_uri"]      = "#{spec.homepage}/releases"
 
   # Specify which files should be added to the gem when it is released.

data/sorbet/rbi/gems/activesupport@7.1.3.rbi

@@ -10908,43 +10908,43 @@ class ActiveSupport::TestCase < ::Minitest::Test
   # source://activesupport//lib/active_support/callbacks.rb#963
   def _teardown_callbacks; end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#736
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#736
   def assert_no_match(matcher, obj, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#665
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#665
   def assert_not_empty(obj, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#676
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#676
   def assert_not_equal(exp, act, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#688
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#688
   def assert_not_in_delta(exp, act, delta = T.unsafe(nil), msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#700
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#700
   def assert_not_in_epsilon(a, b, epsilon = T.unsafe(nil), msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#707
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#707
   def assert_not_includes(collection, obj, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#718
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#718
   def assert_not_instance_of(cls, obj, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#728
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#728
   def assert_not_kind_of(cls, obj, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#746
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#746
   def assert_not_nil(obj, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#781
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#781
   def assert_not_operator(o1, op, o2 = T.unsafe(nil), msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#804
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#804
   def assert_not_predicate(o1, op, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#813
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#813
   def assert_not_respond_to(obj, meth, msg = T.unsafe(nil), include_all: T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#822
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#822
   def assert_not_same(exp, act, msg = T.unsafe(nil)); end
 
   # source://activesupport//lib/active_support/testing/file_fixtures.rb#20
@@ -10956,7 +10956,7 @@ class ActiveSupport::TestCase < ::Minitest::Test
   # source://activesupport//lib/active_support/test_case.rb#298
   def inspect; end
 
-  # source://minitest/5.21.1/lib/minitest.rb#311
+  # source://minitest/5.21.2/lib/minitest.rb#311
   def method_name; end
 
   class << self
@@ -13364,7 +13364,7 @@ end
 # source://activesupport//lib/active_support/xml_mini/rexml.rb#11
 ActiveSupport::XmlMini_REXML::CONTENT_KEY = T.let(T.unsafe(nil), String)
 
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#83
+# source://activesupport//lib/active_support/core_ext/object/to_query.rb#39
 class Array
   include ::Enumerable
 
@@ -13699,6 +13699,13 @@ class Date
   # source://activesupport//lib/active_support/core_ext/date/calculations.rb#152
   def <=>(other); end
 
+  # Duck-types as a Date-like class. See Object#acts_like?.
+  #
+  # @return [Boolean]
+  #
+  # source://activesupport//lib/active_support/core_ext/date/acts_like.rb#7
+  def acts_like_date?; end
+
   # Provides precise Date calculations for years, months, and days. The +options+ parameter takes a hash with
   # any of these keys: <tt>:years</tt>, <tt>:months</tt>, <tt>:weeks</tt>, <tt>:days</tt>.
   #
@@ -15253,7 +15260,7 @@ class Exception
   def as_json(options = T.unsafe(nil)); end
 end
 
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#61
+# source://activesupport//lib/active_support/core_ext/object/to_query.rb#32
 class FalseClass
   # source://activesupport//lib/active_support/core_ext/object/json.rb#89
   def as_json(options = T.unsafe(nil)); end
@@ -16397,7 +16404,7 @@ class NameError < ::StandardError
   include ::DidYouMean::Correctable
 end
 
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#50
+# source://activesupport//lib/active_support/core_ext/object/to_query.rb#18
 class NilClass
   # source://activesupport//lib/active_support/core_ext/object/json.rb#95
   def as_json(options = T.unsafe(nil)); end
@@ -16438,7 +16445,7 @@ class NilClass
   def try!(*_arg0); end
 end
 
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#134
+# source://activesupport//lib/active_support/core_ext/numeric/time.rb#9
 class Numeric
   include ::Comparable
 
@@ -16469,6 +16476,20 @@ class Numeric
   # source://activesupport//lib/active_support/core_ext/numeric/bytes.rb#15
   def bytes; end
 
+  # Returns a Duration instance matching the number of days provided.
+  #
+  #   2.days # => 2 days
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#37
+  def day; end
+
+  # Returns a Duration instance matching the number of days provided.
+  #
+  #   2.days # => 2 days
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#37
+  def days; end
+
   # Returns the number of bytes equivalent to the exabytes provided.
   #
   #   2.exabytes # => 2_305_843_009_213_693_952
@@ -16483,6 +16504,20 @@ class Numeric
   # source://activesupport//lib/active_support/core_ext/numeric/bytes.rb#63
   def exabytes; end
 
+  # Returns a Duration instance matching the number of fortnights provided.
+  #
+  #   2.fortnights # => 4 weeks
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#53
+  def fortnight; end
+
+  # Returns a Duration instance matching the number of fortnights provided.
+  #
+  #   2.fortnights # => 4 weeks
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#53
+  def fortnights; end
+
   # Returns the number of bytes equivalent to the gigabytes provided.
   #
   #   2.gigabytes # => 2_147_483_648
@@ -16497,11 +16532,34 @@ class Numeric
   # source://activesupport//lib/active_support/core_ext/numeric/bytes.rb#39
   def gigabytes; end
 
+  # Returns a Duration instance matching the number of hours provided.
+  #
+  #   2.hours # => 2 hours
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#29
+  def hour; end
+
+  # Returns a Duration instance matching the number of hours provided.
+  #
+  #   2.hours # => 2 hours
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#29
+  def hours; end
+
   # @return [Boolean]
   #
   # source://activesupport//lib/active_support/core_ext/string/output_safety.rb#13
   def html_safe?; end
 
+  # Returns the number of milliseconds equivalent to the seconds provided.
+  # Used with the standard time durations.
+  #
+  #   2.in_milliseconds # => 2000
+  #   1.hour.in_milliseconds # => 3600000
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#63
+  def in_milliseconds; end
+
   # Returns the number of bytes equivalent to the kilobytes provided.
   #
   #   2.kilobytes # => 2048
@@ -16530,6 +16588,20 @@ class Numeric
   # source://activesupport//lib/active_support/core_ext/numeric/bytes.rb#31
   def megabytes; end
 
+  # Returns a Duration instance matching the number of minutes provided.
+  #
+  #   2.minutes # => 2 minutes
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#21
+  def minute; end
+
+  # Returns a Duration instance matching the number of minutes provided.
+  #
+  #   2.minutes # => 2 minutes
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#21
+  def minutes; end
+
   # Returns the number of bytes equivalent to the petabytes provided.
   #
   #   2.petabytes # => 2_251_799_813_685_248
@@ -16544,6 +16616,20 @@ class Numeric
   # source://activesupport//lib/active_support/core_ext/numeric/bytes.rb#55
   def petabytes; end
 
+  # Returns a Duration instance matching the number of seconds provided.
+  #
+  #   2.seconds # => 2 seconds
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#13
+  def second; end
+
+  # Returns a Duration instance matching the number of seconds provided.
+  #
+  #   2.seconds # => 2 seconds
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#13
+  def seconds; end
+
   # Returns the number of bytes equivalent to the terabytes provided.
   #
   #   2.terabytes # => 2_199_023_255_552
@@ -16558,6 +16644,20 @@ class Numeric
   # source://activesupport//lib/active_support/core_ext/numeric/bytes.rb#47
   def terabytes; end
 
+  # Returns a Duration instance matching the number of weeks provided.
+  #
+  #   2.weeks # => 2 weeks
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#45
+  def week; end
+
+  # Returns a Duration instance matching the number of weeks provided.
+  #
+  #   2.weeks # => 2 weeks
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#45
+  def weeks; end
+
   # Returns the number of bytes equivalent to the zettabytes provided.
   #
   #   2.zettabytes # => 2_361_183_241_434_822_606_848
@@ -16613,7 +16713,7 @@ Numeric::ZETTABYTE = T.let(T.unsafe(nil), Integer)
 # using that rescue idiom.
 # ++
 #
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#5
+# source://activesupport//lib/active_support/core_ext/object/to_query.rb#5
 class Object < ::BasicObject
   include ::ActiveSupport::ToJsonWithActiveSupportEncoder
   include ::ActiveSupport::Dependencies::RequireDependency
@@ -16820,7 +16920,7 @@ end
 #
 #   'ScaleScore'.tableize # => "scale_scores"
 #
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#103
+# source://activesupport//lib/active_support/core_ext/string/multibyte.rb#5
 class String
   include ::Comparable
 
@@ -17477,7 +17577,7 @@ class Thread
   def active_support_execution_state=(_arg0); end
 end
 
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#146
+# source://activesupport//lib/active_support/core_ext/time/conversions.rb#7
 class Time
   include ::Comparable
   include ::DateAndTime::Zones
@@ -17974,7 +18074,7 @@ Time::COMMON_YEAR_DAYS_IN_MONTH = T.let(T.unsafe(nil), Array)
 # source://activesupport//lib/active_support/core_ext/time/conversions.rb#8
 Time::DATE_FORMATS = T.let(T.unsafe(nil), Hash)
 
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#72
+# source://activesupport//lib/active_support/core_ext/object/to_query.rb#25
 class TrueClass
   # source://activesupport//lib/active_support/core_ext/object/json.rb#83
   def as_json(options = T.unsafe(nil)); end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lunchmoney
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - "@halorrr"
@@ -205,6 +205,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/halorrr/lunchmoney
   source_code_uri: https://github.com/halorrr/lunchmoney
+  documentation_uri: https://halorrr.github.io/lunchmoney/
   changelog_uri: https://github.com/halorrr/lunchmoney/releases
 post_install_message: 
 rdoc_options: []