seller_ledger-ruby 1.0.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 434363366daf337993198517b9e6d09863f0d9468eb5349afe01b33f36f0b88f
-  data.tar.gz: 27b1e0190cf222b859969332cb2df177271f1da740010ad5143cd8d601c8e8a2
+  metadata.gz: 39ace969eea3dcd86fe39df969357fd3f7637bb1ec43ef824cdc5d4b2c944cc6
+  data.tar.gz: a13c768184a164d79bb745c54ca3528a1acfd7ed50dd40cef15bbee75af5252d
 SHA512:
-  metadata.gz: dded41a31c8235e4006e1ed7e4c2f808f4d63e374b09f637341b7faf507c2282d3ceb80d172ecaa03e72d5e873308905296c661fa1698f1eacb4e8e32e322611
-  data.tar.gz: d092730d6981b17c778dee32c0555438125ea5afa77b654f3f40157ea6a53ba6c3a13f2b23a184a42e366f7d78874c9c14a04f5fe0421202e037117b753f22d2
+  metadata.gz: 7c32ab845438a1aa9e320f669e06562b9fcbfc02d939bb999b130bd41f878a205ef1cec67e9e3d2dc0d1d79530bd54ae9d4a174782efed25a599ba2bd52f10fb
+  data.tar.gz: e7f726cbd71d87521948ee2a1b62865fce97e819e50c340ebbd501084c72ee32ccbc60cac008394f3b75db9d6f257221ddee1985d2dd08f2b431a2600378dfa6

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## [Unreleased]
+## [1.2.0] - 2024-06-26
+
+- Raise if required parameters are nil or blank
+
+## [1.1.0] - 2024-06-26
+
+- Account, business, connection, and inventory endpoints
 
 ## [1.0.0] - 2024-04-29
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seller_ledger-ruby (1.0.0)
+    seller_ledger-ruby (1.2.0)
       faraday
       json
 
@@ -9,6 +9,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    coderay (1.1.3)
     diff-lcs (1.5.1)
     faraday (2.9.0)
       faraday-net_http (>= 2.0, < 3.2)
@@ -16,12 +17,16 @@ GEM
       net-http
     json (2.7.2)
     language_server-protocol (3.17.0.3)
+    method_source (1.1.0)
     net-http (0.4.1)
       uri
     parallel (1.24.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.2.1)
@@ -61,6 +66,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  pry
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)

data/README.md

@@ -4,11 +4,11 @@
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add seller_ledger
+    $ bundle add seller_ledger-ruby
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install seller_ledger
+    $ gem install seller_ledger-ruby
 
 ## Usage
 

data/lib/seller_ledger/client/accounts.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module SellerLedger
+  class Client
+    module Accounts
+      def list_accounts(params = {})
+        paginated_request(
+          "/v1/accounts",
+          params,
+          "accounts"
+        )
+      end
+
+      def get_account(id)
+        validate(id)
+        get("/v1/accounts/#{id}")
+      end
+
+      def list_account_transactions(id, params = {})
+        validate(id)
+        paginated_request(
+          "/v1/accounts/#{id}/transactions",
+          params,
+          "transactions"
+        )
+      end
+
+      def list_account_entries(id, params = {})
+        validate(id)
+        paginated_request(
+          "/v1/accounts/#{id}/entries",
+          params,
+          "entries"
+        )
+      end
+    end
+  end
+end

data/lib/seller_ledger/client/business.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SellerLedger
+  class Client
+    module Business
+      def get_business
+        get("/v1/business")
+      end
+    end
+  end
+end

data/lib/seller_ledger/client/connection_transactions.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module SellerLedger
+  class Client
+    module ConnectionTransactions
+      def list_orders(connection_id, params = {})
+        validate(connection_id)
+        paginated_request(
+          "/v1/connections/#{connection_id}/orders",
+          params,
+          "transactions"
+        )
+      end
+
+      def create_order(connection_id, params)
+        validate(connection_id)
+        post("/v1/connections/#{connection_id}/orders", params)
+      end
+
+      def update_order(connection_id, transaction_id, params)
+        validate(connection_id)
+        validate(transaction_id)
+        put("/v1/connections/#{connection_id}/orders/#{transaction_id}", params)
+      end
+
+      def get_order(connection_id, transaction_id)
+        validate(connection_id)
+        validate(transaction_id)
+        get("/v1/connections/#{connection_id}/orders/#{transaction_id}")
+      end
+
+      def delete_order(connection_id, transaction_id)
+        validate(connection_id)
+        validate(transaction_id)
+        delete("/v1/connections/#{connection_id}/orders/#{transaction_id}")
+      end
+
+      def list_refunds(connection_id, params = {})
+        validate(connection_id)
+        paginated_request(
+          "/v1/connections/#{connection_id}/refunds",
+          params,
+          "transactions"
+        )
+      end
+
+      def create_refund(connection_id, params)
+        validate(connection_id)
+        post("/v1/connections/#{connection_id}/refunds", params)
+      end
+
+      def update_refund(connection_id, transaction_id, params)
+        validate(connection_id)
+        validate(transaction_id)
+        put("/v1/connections/#{connection_id}/refunds/#{transaction_id}", params)
+      end
+
+      def get_refund(connection_id, transaction_id)
+        validate(connection_id)
+        validate(transaction_id)
+        get("/v1/connections/#{connection_id}/refunds/#{transaction_id}")
+      end
+
+      def delete_refund(connection_id, transaction_id)
+        validate(connection_id)
+        validate(transaction_id)
+        delete("/v1/connections/#{connection_id}/refunds/#{transaction_id}")
+      end
+    end
+  end
+end

data/lib/seller_ledger/client/connections.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SellerLedger
+  class Client
+    module Connections
+      def list_connections(params = {})
+        paginated_request(
+          "/v1/connections",
+          params,
+          "connections"
+        )
+      end
+
+      def create_connection(params)
+        post("/v1/connections", params)
+      end
+
+      def get_connection(id)
+        validate(id)
+        get("/v1/connections/#{id}")
+      end
+
+      def delete_connection(id)
+        validate(id)
+        delete("/v1/connections/#{id}")
+      end
+    end
+  end
+end

data/lib/seller_ledger/client/inventory.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SellerLedger
+  class Client
+    module Inventory
+      def list_inventory_purchases(params = {})
+        paginated_request(
+          "/v1/inventory/purchases",
+          params,
+          "purchases"
+        )
+      end
+
+      def create_inventory_purchase(params)
+        post("/v1/inventory/purchases", params)
+      end
+
+      def get_inventory_purchase(id)
+        validate(id)
+        get("/v1/inventory/purchases/#{id}")
+      end
+
+      def delete_inventory_purchase(id)
+        validate(id)
+        delete("/v1/inventory/purchases/#{id}")
+      end
+    end
+  end
+end

data/lib/seller_ledger/client/mileage_transactions.rb

@@ -3,28 +3,31 @@
 module SellerLedger
   class Client
     module MileageTransactions
-      def list_mileage_transactions(params = {})
+      def list_mileage_expenses(params = {})
         paginated_request(
-          "/v1/transactions/mileage",
+          "/v1/mileage_expenses",
           params,
-          "transactions"
+          "mileage_expenses"
         )
       end
 
-      def create_mileage_transaction(params)
-        post("/v1/transactions/mileage", params)
+      def create_mileage_expense(params)
+        post("/v1/mileage_expenses", params)
       end
 
-      def update_mileage_transaction(id, params)
-        put("/v1/transactions/mileage/#{id}", params)
+      def update_mileage_expense(id, params)
+        validate(id)
+        put("/v1/mileage_expenses/#{id}", params)
       end
 
-      def get_mileage_transaction(id)
-        get("/v1/transactions/mileage/#{id}")
+      def get_mileage_expense(id)
+        validate(id)
+        get("/v1/mileage_expenses/#{id}")
       end
 
-      def delete_mileage_transaction(id)
-        delete("/v1/transactions/mileage/#{id}")
+      def delete_mileage_expense(id)
+        validate(id)
+        delete("/v1/mileage_expenses/#{id}")
       end
     end
   end

data/lib/seller_ledger/client/transactions.rb

@@ -11,8 +11,23 @@ module SellerLedger
         )
       end
 
-      def get_transaction(id)
-        get("/v1/transactions/#{id}")
+      def get_transaction(id, params = {})
+        validate(id)
+        get("/v1/transactions/#{id}", params)
+      end
+
+      def create_transaction(params)
+        post("/v1/transactions", params)
+      end
+
+      def update_transaction(id, params)
+        validate(id)
+        put("/v1/transactions/#{id}", params)
+      end
+
+      def delete_transaction(id, params = {})
+        validate(id)
+        delete("/v1/transactions/#{id}", params)
       end
     end
   end

data/lib/seller_ledger/client.rb

@@ -2,19 +2,25 @@
 
 require "faraday"
 require "json"
+require "seller_ledger/client/accounts"
+require "seller_ledger/client/business"
 require "seller_ledger/client/categories"
-require "seller_ledger/client/transactions"
+require "seller_ledger/client/connections"
+require "seller_ledger/client/connection_transactions"
+require "seller_ledger/client/inventory"
 require "seller_ledger/client/mileage_transactions"
-require "seller_ledger/client/income_transactions"
-require "seller_ledger/client/expense_transactions"
+require "seller_ledger/client/transactions"
 
 module SellerLedger
   class Client
+    include SellerLedger::Client::Accounts
+    include SellerLedger::Client::Business
     include SellerLedger::Client::Categories
-    include SellerLedger::Client::Transactions
+    include SellerLedger::Client::Connections
+    include SellerLedger::Client::ConnectionTransactions
+    include SellerLedger::Client::Inventory
     include SellerLedger::Client::MileageTransactions
-    include SellerLedger::Client::IncomeTransactions
-    include SellerLedger::Client::ExpenseTransactions
+    include SellerLedger::Client::Transactions
 
     def initialize(token:, url: "https://api.sellerledger.com")
       @token = token
@@ -33,14 +39,15 @@ module SellerLedger
       request(:put, url, params).body
     end
 
-    def delete(url)
-      request(:delete, url).body
+    def delete(url, params = {})
+      request(:delete, url, params).body
     end
 
     def request(method, url, params)
       response = agent.send(method, url, params)
       raise SellerLedger::Errors::Unauthenticated.new if response.status == 401
-      raise SellerLedger::Errors::Generic.new(response.body["error"]) if response.body["error"].present?
+      error = response.body["error"]
+      raise SellerLedger::Errors::Generic.new(error) if error != nil && error != ""
       response
     end
 
@@ -66,5 +73,9 @@ module SellerLedger
         f.response :json
       end
     end
+
+    def validate(value)
+      raise SellerLedger::Errors::ValueError.new if value == nil || value == ""
+    end
   end
 end

data/lib/seller_ledger/errors.rb

@@ -8,5 +8,11 @@ module SellerLedger
 
     class Generic < StandardError
     end
+
+    class ValueError < StandardError
+      def to_s
+        "Method parameter cannot be nil or an empty string"
+      end
+    end
   end
 end

data/lib/seller_ledger/version.rb

@@ -3,7 +3,7 @@
 module SellerLedger
   MAJOR = 1
 
-  MINOR = 0
+  MINOR = 5
 
   PATCH = 0
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seller_ledger-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Kevin Reeth
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby wrapper for interacting with the Seller Ledger API
 email:
 - kevin@sellerledger.com
@@ -54,9 +68,12 @@ files:
 - Rakefile
 - lib/seller_ledger.rb
 - lib/seller_ledger/client.rb
+- lib/seller_ledger/client/accounts.rb
+- lib/seller_ledger/client/business.rb
 - lib/seller_ledger/client/categories.rb
-- lib/seller_ledger/client/expense_transactions.rb
-- lib/seller_ledger/client/income_transactions.rb
+- lib/seller_ledger/client/connection_transactions.rb
+- lib/seller_ledger/client/connections.rb
+- lib/seller_ledger/client/inventory.rb
 - lib/seller_ledger/client/mileage_transactions.rb
 - lib/seller_ledger/client/transactions.rb
 - lib/seller_ledger/errors.rb

data/lib/seller_ledger/client/expense_transactions.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module SellerLedger
-  class Client
-    module ExpenseTransactions
-      def list_expense_transactions(params = {})
-        paginated_request(
-          "/v1/transactions/expenses",
-          params,
-          "transactions"
-        )
-      end
-
-      def create_expense_transaction(params)
-        post("/v1/transactions/expenses", params)
-      end
-
-      def update_expense_transaction(id, params)
-        put("/v1/transactions/expenses/#{id}", params)
-      end
-
-      def get_expense_transaction(id)
-        get("/v1/transactions/expenses/#{id}")
-      end
-
-      def delete_expense_transaction(id)
-        delete("/v1/transactions/expenses/#{id}")
-      end
-    end
-  end
-end

data/lib/seller_ledger/client/income_transactions.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module SellerLedger
-  class Client
-    module IncomeTransactions
-      def list_income_transactions(params = {})
-        paginated_request(
-          "/v1/transactions/income",
-          params,
-          "transactions"
-        )
-      end
-
-      def create_income_transaction(params)
-        post("/v1/transactions/income", params)
-      end
-
-      def update_income_transaction(id, params)
-        put("/v1/transactions/income/#{id}", params)
-      end
-
-      def get_income_transaction(id)
-        get("/v1/transactions/income/#{id}")
-      end
-
-      def delete_income_transaction(id)
-        delete("/v1/transactions/income/#{id}")
-      end
-    end
-  end
-end