pennylane 0.1.0 → 0.2.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da1842f4d3dee5f1bd7c9bccd793eb1c185cb5fece2178e967da0cbec3b752be
-  data.tar.gz: 1f050f189dae434bdf4febe2c7715858b1f422273a129aa6654677c95ba94921
+  metadata.gz: 9a60c1035dbad731707f86c3e97610c740d286cb8e6f70b7ac30709bbe29a0f0
+  data.tar.gz: b3fd35e53857c0d8df547bb361d4ae69bd1b73a482b7552232ab4cfcce5e8926
 SHA512:
-  metadata.gz: c245562b9cdcfc4754348d1a43d2029d5b6d025cd61191c0ceeb3e7b814ed81bae299cc7e86b76799a11275fc296a4e5fd8080ab133f262981ccf9091fad665f
-  data.tar.gz: 0404a595eedc597bc04c2dafa9db4796e1ab9d6a12a0bfc9f28132195b50f0ebe8516552c5de04326ed1d79cfef97a2d07de0e7b30ce6fd188abc991e07a221c
+  metadata.gz: 903f576a32e59f954c68c255ce0aeacf6a820315f233f9825b2d35036cff3ab0928c6ac9fb0e84daa059da40dfde4f1829c5dff61ad58a57a406a3483e69b9e8
+  data.tar.gz: 72ed99e03c1d31ff1a871ebf0d335110c9a0a38a9acc9d8e14ecaf27a50731afef55ce6d1c77d89cbb0f95558eba121938ba8da7b87827e6c2416be10def3c5d

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.2.0-alpha] - 2024-04-20
+
+- Support resources 
+  - `CategoryGroup`
+  - `Category` 
+  - `Product`
+- Added missing `#create` to `Supplier`
+- Adding `#update` to `Customer` and `Supplier`
+
+
 ## [0.1.0] - 2024-04-04
 
-- Initial release
+- Initial release

data/Gemfile.lock

@@ -1,15 +1,33 @@
 PATH
   remote: .
   specs:
-    pennylane (0.1.0)
+    pennylane (0.2.0.pre.alpha)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
     ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    drb (2.2.1)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     minitest (5.22.3)
+    mutex_m (0.2.0)
     parallel (1.24.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)
@@ -36,6 +54,8 @@ GEM
     ruby-progressbar (1.13.0)
     test-unit (3.6.2)
       power_assert
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
     vcr (6.2.0)
 
@@ -43,6 +63,7 @@ PLATFORMS
   arm64-darwin-22
 
 DEPENDENCIES
+  activesupport (~> 7.1)
   minitest (~> 5.22)
   pennylane!
   rake (~> 13.0)

data/README.md

@@ -38,6 +38,32 @@ Pennylane::Customer.list(filter: [{field: 'name', operator: 'eq', value: 'Apple'
 
 # Retrieve single customer
 Pennylane::Customer.retrieve('38a1f19a-256d-4692-a8fe-0a16403f59ff')
+
+# Update a customer
+cus = Pennylane::Customer.retrieve('38a1f19a-256d-4692-a8fe-0a16403f59ff')
+cus.update(name: 'Apple Inc')
+
+```
+
+### Per-request api key [TODO]
+For apps that need to use multiple keys during the lifetime of a process. it's also possible to set a per-request key:
+```ruby
+require "pennylane"
+
+Pennylane::Customer.list(
+  {},
+  {
+    api_key: 'x1fa....'
+  }
+)
+
+Pennylane::Customer.retrieve(
+  '38a1f19a-256d-4692-a8fe-0a16403f59ff',
+  {
+    api_key: 'x1fa....'
+  }
+)
+
 ```
 
 ## Test mode
@@ -50,6 +76,26 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+Resources implemented so far :
+### CUSTOMER INVOICING
+
+- Customer Invoices 🚧
+- Estimates 🚧
+- Billing Subscriptions 🚧
+
+### REFERENTIALS
+
+- Customers ✅
+- Suppliers ✅
+- Categories ✅
+- CategoryGroups ✅
+- Products ✅
+- Plan Items 🚧
+- Enums 🚧
+
+### SUPPLIER INVOICING
+- Supplier Invoices 🚧
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/sbounmy/pennylane. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/pennylane/blob/main/CODE_OF_CONDUCT.md).

data/lib/pennylane/client.rb

@@ -36,8 +36,7 @@ module Pennylane
 
     def request method, path, params:, opts: {}
       req = initialize_request(method, path, params[:query]).tap do |req|
-        req.body = params[:body].to_json if params[:body] && method != :get
-        # req.query = params if !params.empty? && method == :get
+        req.body = params[:body].to_json if params[:body]
       end
 
       http.request(req).tap do |resp|

data/lib/pennylane/object.rb

@@ -1,10 +1,7 @@
 module Pennylane
   class Object
     include Enumerable
-
-    def initialize(id = nil)
-      @id = id
-    end
+    attr_reader :id
 
     def initialize_from_response(response, params = {}, opts = {})
       values = Util.symbolize_names(response)
@@ -19,7 +16,7 @@ module Pennylane
     end
 
     def self.build_from(response, params = {}, opts = {})
-      new(response['id']).initialize_from_response(response, params, opts)
+      new.initialize_from_response(response, params, opts)
     end
 
     def self.objects

data/lib/pennylane/resources/base.rb

@@ -11,9 +11,9 @@ module Pennylane
           "#{object_name}s"
         end
 
-        def request_pennylane_object(method:, path:, params: {}, opts: {}, usage: [])
+        def request_pennylane_object(method:, path:, params: {}, opts: {}, usage: [], with: {})
           resp, opts = execute_resource_request(method, path, params, opts, usage)
-          Util.convert_to_pennylane_object(Util.normalize_response(resp), params, opts)
+          Util.convert_to_pennylane_object(Util.normalize_response(resp, with), params, opts)
         end
 
         def execute_resource_request(method, path, params = {}, opts = {}, usage = [])
@@ -33,18 +33,46 @@ module Pennylane
         def client
           @client ||= Pennylane::Client.new(Pennylane.api_key)
         end
+
+        def normalize_filters(filters)
+          filters[:filter] = filters[:filter].to_json if filters[:filter]
+          filters
+        end
+      end
+
+      # object happens to be nil when the object is in a list
+      def id
+        object.source_id
+      rescue
+        super
+      end
+
+      #
+      def object
+        @values[self.class.object_name.to_sym]
+      end
+
+      # def inspect
+      #   id_string = respond_to?(:id) && !id.nil? ? " id=#{id}" : ""
+      #   "#<#{self.class}:0x#{object_id.to_s(16)}#{id_string}> JSON: " +
+      #     JSON.pretty_generate(object.instance_variable_get(:@values) || @values)
+      # end
+
+      def update(attributes)
+        resp, opts = self.class.request_pennylane_object(method: :put, path: "/#{self.class.object_name_plural}/#{id}", params: { body: { self.class.object_name => attributes } })
+        @values = resp.instance_variable_get :@values
+        self
       end
 
       # So we can call directly method on the object rather than going through his key
       # Pennylane::Customer.retrieve('any-id').name == Pennylane::Customer.retrieve('any-id').customer.name
       def method_missing(method_name, *args, &block)
-        obj = @values[self.class.object_name.to_sym]
-        raise NoMethodError, "undefined method `#{method_name}` for #{self.class}" unless obj
-        obj.send(method_name, *args, &block)
+        raise NoMethodError, "undefined method `#{method_name}` for #{self.class}" unless object
+        object.send(method_name, *args, &block)
       end
 
       def respond_to_missing?(method_name, include_private = false)
-        @values[self.class.object_name.to_sym].respond_to?(method_name) || super
+        object.respond_to?(method_name) || super
       end
 
     end

data/lib/pennylane/resources/category.rb

@@ -0,0 +1,27 @@
+module Pennylane
+  class Category < Resources::Base
+
+    class << self
+
+      # override the object_name_plural method otherwise it will return 'categorys'
+      def object_name_plural
+        'categories'
+      end
+
+      def list filters = {}, opts = {}
+        normalize_filters(filters)
+        request_pennylane_object(method: :get, path: "/categories", params: { query: filters }, opts: opts)
+      end
+
+      def retrieve id, opts = {}
+        request_pennylane_object(method: :get, path: "/categories/#{id}", params: {}, opts: opts)
+      end
+
+      def create params, opts = {}
+        request_pennylane_object(method: :post, path: "/categories", params: { body: { object_name => params } }, opts: opts)
+      end
+
+    end
+
+  end
+end

data/lib/pennylane/resources/category_group.rb

@@ -0,0 +1,16 @@
+module Pennylane
+  class CategoryGroup < Resources::Base
+
+    class << self
+
+      def object_name
+        'category_group'
+      end
+
+      def list filters = {}, opts = {}
+        request_pennylane_object(method: :get, path: "/category_groups", params: { query: filters }, opts: opts)
+      end
+    end
+
+  end
+end

data/lib/pennylane/resources/customer.rb

@@ -4,11 +4,12 @@ module Pennylane
     class << self
 
       def list filters = {}, opts = {}
+        normalize_filters(filters)
         request_pennylane_object(method: :get, path: "/customers", params: { query: filters }, opts: opts)
       end
 
-      def retrieve customer_id, opts = {}
-        request_pennylane_object(method: :get, path: "/customers/#{customer_id}", params: {}, opts: opts)
+      def retrieve id, opts = {}
+        request_pennylane_object(method: :get, path: "/customers/#{id}", params: {}, opts: opts)
       end
 
       def create params, opts = {}

data/lib/pennylane/resources/customer_invoice.rb

@@ -0,0 +1,45 @@
+module Pennylane
+  class CustomerInvoice < Resources::Base
+
+    class << self
+
+      def object_name
+        'customer_invoice'
+      end
+
+      def list filters = {}, opts = {}
+        normalize_filters(filters)
+        request_pennylane_object(method: :get, path: "/customer_invoices", params: { query: filters }, opts: opts, with: { invoice: 'customer_invoice' })
+      end
+
+      def retrieve id, opts = {}
+        request_pennylane_object(method: :get, path: "/customer_invoices/#{id}", params: {}, opts: opts, with: { invoice: 'customer_invoice' })
+      end
+
+      def create params, opts = {}
+        request_pennylane_object(method: :post, path: "/customer_invoices", params: { body: params }, opts: opts, with: { invoice: 'customer_invoice' })
+      end
+
+    end
+
+    # since object name is different from the class name, we need to override the method
+    def update(attributes)
+      resp, opts = self.class.request_pennylane_object(method: :put, path: "/#{self.class.object_name_plural}/#{id}",
+                                                       params: { body: { 'invoice' => attributes } },
+                                                       opts: {}, with: { invoice: 'customer_invoice' })
+      @values = resp.instance_variable_get :@values
+      self
+    end
+
+    # since object name is different from the class name, we need to override the object_name method
+    def object
+      @values[:invoice]
+    end
+
+    # doesnt have a `source_id` so we override it
+    def id
+      object.id
+    end
+
+  end
+end

data/lib/pennylane/resources/product.rb

@@ -0,0 +1,22 @@
+module Pennylane
+  class Product < Resources::Base
+
+    class << self
+
+      def list filters = {}, opts = {}
+        normalize_filters(filters)
+        request_pennylane_object(method: :get, path: "/products", params: { query: filters }, opts: opts)
+      end
+
+      def retrieve id, opts = {}
+        request_pennylane_object(method: :get, path: "/products/#{id}", params: {}, opts: opts)
+      end
+
+      def create params, opts = {}
+        request_pennylane_object(method: :post, path: "/products", params: { body: { product: params } }, opts: opts)
+      end
+
+    end
+
+  end
+end

data/lib/pennylane/resources/supplier.rb

@@ -0,0 +1,20 @@
+module Pennylane
+  class Supplier < Resources::Base
+    class << self
+
+      def list filters = {}, opts = {}
+        normalize_filters(filters)
+        request_pennylane_object(method: :get, path: "/suppliers", params: { query: filters }, opts: opts)
+      end
+
+      def retrieve supplier_id, opts = {}
+        request_pennylane_object(method: :get, path: "/suppliers/#{supplier_id}", params: {}, opts: opts)
+      end
+
+      def create params, opts = {}
+        request_pennylane_object(method: :post, path: "/suppliers", params: { body: { object_name => params } }, opts: opts)
+      end
+
+    end
+  end
+end

data/lib/pennylane/util.rb

@@ -20,28 +20,38 @@ module Pennylane
       # It will add an _object key to each hash in the response
       # This key will contain the name of the object
       # It will also add an _object key to the root of the response
-      def normalize_response(object)
+      # with: is used to map the object name to a different class
+      # Example : GET /customer_invoices will return a list of invoices
+      #  {
+      #   "total_pages": 5,
+      #   "current_page": 1,
+      #   "total_invoices": 12,
+      #   "invoices": []
+      # }
+      # `invoices` should be `customer_invoice` so we can cast it to the right class CustomerInvoice
+      # Since we don't have the ability to change the API response.
+      # We can achieve this by calling normalize_response(response, with: {invoice: 'customer_invoice'})
+      def normalize_response(object, with={})
         # puts object.inspect
         case object
         when Hash
           new_hash = {}
-          new_hash['_object'] = object.has_key?('total_pages') ? 'list' : singularize(object.keys.first)
-
+          new_hash['_object'] = object.has_key?('total_pages') ? 'list' : (with[singularize(object.keys.first).to_sym] || singularize(object.keys.first))
           object.each do |key, value|
             if value.is_a? Array
               new_hash[key] = value.map do |h|
-                h['_object'] = singularize(key) if h.is_a? Hash
-                normalize_response(h)
+                h['_object'] = with[singularize(key).to_sym] || singularize(key) if h.is_a? Hash
+                normalize_response(h, with)
               end
             elsif value.is_a? Hash
-              value['_object'] = singularize(key)
+              value['_object'] = with[singularize(key).to_sym] || singularize(key)
             end
-            new_hash[key] = normalize_response(value)
+            new_hash[key] = normalize_response(value, with)
           end
           new_hash
         when Array
           object.map do |value|
-            normalize_response(value)
+            normalize_response(value, with)
           end
         else
           object

data/lib/pennylane/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pennylane
-  VERSION = "0.1.0"
-end
+  VERSION = "0.2.0-alpha"
+end

data/lib/pennylane.rb

@@ -22,7 +22,12 @@ module Pennylane
 
   API_RESOURCES = {
     ListObject.object_name => ListObject,
-    Customer.object_name => Customer
+    Category.object_name => Category,
+    CategoryGroup.object_name => CategoryGroup,
+    Customer.object_name => Customer,
+    CustomerInvoice.object_name => CustomerInvoice,
+    Product.object_name => Product,
+    Supplier.object_name => Supplier
   }.freeze
 
   @config = Pennylane::Configuration.new

data/pennylane.gemspec

@@ -34,5 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr", "~> 6.2"
   spec.add_development_dependency "test-unit", "~> 3.6"
   spec.add_development_dependency "minitest", "~> 5.22"
+  spec.add_development_dependency "activesupport", "~> 7.1"
   # guide at: https://bundler.io/guides/creating_gem.html
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pennylane
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0.pre.alpha
 platform: ruby
 authors:
 - Stephane Bounmy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-14 00:00:00.000000000 Z
+date: 2024-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.22'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
 description: Pennylane offers integrated financial management and accounting tools
   for businesses. See https://pennylane.com for details.
 email:
@@ -74,7 +88,12 @@ files:
 - lib/pennylane/list_object.rb
 - lib/pennylane/object.rb
 - lib/pennylane/resources/base.rb
+- lib/pennylane/resources/category.rb
+- lib/pennylane/resources/category_group.rb
 - lib/pennylane/resources/customer.rb
+- lib/pennylane/resources/customer_invoice.rb
+- lib/pennylane/resources/product.rb
+- lib/pennylane/resources/supplier.rb
 - lib/pennylane/util.rb
 - lib/pennylane/version.rb
 - pennylane.gemspec
@@ -97,9 +116,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.10
 signing_key: