castle-rb 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9dc06eac5803e36c8576d9938442ba1c1f6bb852420c7a736044127deea50b8
-  data.tar.gz: 5d89738c670359a0345d51b41d0137d614622002711f20665238a4c289f28bab
+  metadata.gz: 6f571bda5aa4075f18ef7c64173155401d822ced4fe66fe7c4ceaf4c7c6c6c6e
+  data.tar.gz: 15709ff2d5bbdf57063bdd0c1f3eb492f78beff5b1e2b8c61a848f3a2af1d32d
 SHA512:
-  metadata.gz: 118236690b20da223208e043cb4aafea5c1d9870e0d2e44d87106a45122652ca894f8bfbc79bf465e474923a026b9b2253a6c7a1ab2c2f5157b0b21d51459d6c
-  data.tar.gz: 223933e1de62111635ba5d22fed064541a1d54aee9c9374fc8524a808b27b623245ee0d5240a42d0eff4ac72e214cc4f61ce44bb72f15591d3944790d8bc3e0d
+  metadata.gz: 5186002c86cef93deb33c8c03c95ffc81adaa7b59b032a06f2f81ff1423d0cd247d198e0a7fce2a15e2a1ab6a76a986c524644c4f4338be5a7e16ec45ba6cdca
+  data.tar.gz: a9c63ce6293981630ed431471ceb0ffb70fe990b68784f70088dba28140a63e7ff012286604d8da9a79f5b93486ba4cb8e3318c93ee3617c29f6f981ef737d86

data/lib/castle/api/list_items/archive.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    # Namespace for the list items API ednpoints
+    module ListItems
+      # Sends DELETE /lists/:list_id/items/:item_id request
+      module Archive
+        class << self
+          # @param options [Hash]
+          # @return [Hash]
+          def call(options = {})
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+            http = options.delete(:http)
+            config = options.delete(:config) || Castle.config
+
+            Castle::API.call(Castle::Commands::ListItems::Archive.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/list_items/count.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module ListItems
+      # Sends POST /lists/:list_id/items request
+      module Count
+        class << self
+          # @param options [Hash]
+          # @return [Hash]
+          def call(options = {})
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+            http = options.delete(:http)
+            config = options.delete(:config) || Castle.config
+
+            Castle::API.call(Castle::Commands::ListItems::Count.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/list_items/create.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module ListItems
+      # Sends POST /lists/:list_id/items request
+      module Create
+        class << self
+          # @param options [Hash]
+          # @return [Hash]
+          def call(options = {})
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+            http = options.delete(:http)
+            config = options.delete(:config) || Castle.config
+
+            Castle::API.call(Castle::Commands::ListItems::Create.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/list_items/get.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module ListItems
+      # Sends GET /lists/:list_id/items/:item_id request
+      module Get
+        class << self
+          # @param options [Hash]
+          # @return [Hash]
+          def call(options = {})
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+            http = options.delete(:http)
+            config = options.delete(:config) || Castle.config
+
+            Castle::API.call(Castle::Commands::ListItems::Get.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/list_items/query.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module ListItems
+      # Sends POST /lists/:list_id/items/query request
+      module Query
+        class << self
+          # @param options [Hash]
+          # @return [Hash]
+          def call(options = {})
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+            http = options.delete(:http)
+            config = options.delete(:config) || Castle.config
+
+            Castle::API.call(Castle::Commands::ListItems::Query.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/list_items/unarchive.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module ListItems
+      # Sends PUT /lists/:list_id/items/:item_id/unarchive request
+      module Unarchive
+        class << self
+          # @param options [Hash]
+          # @return [Hash]
+          def call(options = {})
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+            http = options.delete(:http)
+            config = options.delete(:config) || Castle.config
+
+            Castle::API.call(Castle::Commands::ListItems::Unarchive.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/list_items/update.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module ListItems
+      # Sends PUT /lists/:list_id/items/:item_id request
+      module Update
+        class << self
+          # @param options [Hash]
+          # @return [Hash]
+          def call(options = {})
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+            http = options.delete(:http)
+            config = options.delete(:config) || Castle.config
+
+            Castle::API.call(Castle::Commands::ListItems::Update.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/lists/create.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    # Namespace for the lists API ednpoints
+    module Lists
+      # Sends POST /lists request
+      module Create
+        class << self
+          # @param options [Hash]
+          # @return [Hash]
+          def call(options = {})
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+            http = options.delete(:http)
+            config = options.delete(:config) || Castle.config
+
+            Castle::API.call(Castle::Commands::Lists::Create.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/lists/delete.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module Lists
+      # Sends DELETE /lists/:list_id request
+      module Delete
+        class << self
+          # @param options [Hash]
+          # @return [Hash]
+          def call(options = {})
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+            http = options.delete(:http)
+            config = options.delete(:config) || Castle.config
+
+            Castle::API.call(Castle::Commands::Lists::Delete.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/lists/get.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module Lists
+      # Sends GET /lists/:list_id request
+      module Get
+        class << self
+          # @param options [Hash]
+          # @return [Hash]
+          def call(options = {})
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+            http = options.delete(:http)
+            config = options.delete(:config) || Castle.config
+
+            Castle::API.call(Castle::Commands::Lists::Get.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/lists/get_all.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module Lists
+      # Sends GET /lists request
+      module GetAll
+        class << self
+          # @param options [Hash]
+          # @return [Hash]
+          def call(options = {})
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+            http = options.delete(:http)
+            config = options.delete(:config) || Castle.config
+
+            Castle::API.call(Castle::Commands::Lists::GetAll.build, {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/lists/query.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module Lists
+      # Sends POST /lists/query request
+      module Query
+        class << self
+          # @param options [Hash]
+          # @return [Hash]
+          def call(options = {})
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+            http = options.delete(:http)
+            config = options.delete(:config) || Castle.config
+
+            Castle::API.call(Castle::Commands::Lists::Query.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/lists/update.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module Lists
+      # Sends PUT /lists/:list_id request
+      module Update
+        class << self
+          # @param options [Hash]
+          # @return [Hash]
+          def call(options = {})
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+            http = options.delete(:http)
+            config = options.delete(:config) || Castle.config
+
+            Castle::API.call(Castle::Commands::Lists::Update.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/client.rb

@@ -3,6 +3,9 @@
 module Castle
   # Castle's client.
   class Client
+    include Castle::ClientActions::ListItems
+    include Castle::ClientActions::Lists
+
     class << self
       def from_request(request, options = {})
         new(options.merge(context: Castle::Context::Prepare.call(request, options)))

data/lib/castle/client_actions/list_items.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Castle
+  # Namesapce for client actions
+  module ClientActions
+    # Client actions for list items
+    module ListItems
+      # @param options [Hash]
+      def archive_list_item(options = {})
+        Castle::API::ListItems::Archive.call(options)
+      end
+
+      # @param options [Hash]
+      def count_list_items(options = {})
+        Castle::API::ListItems::Count.call(options)
+      end
+
+      # @param options [Hash]
+      def create_list_item(options = {})
+        Castle::API::ListItems::Create.call(options)
+      end
+
+      # @param options [Hash]
+      def get_list_item(options = {})
+        Castle::API::ListItems::Get.call(options)
+      end
+
+      # @param options [Hash]
+      def query_list_items(options = {})
+        Castle::API::ListItems::Query.call(options)
+      end
+
+      # @param options [Hash]
+      def unarchive_list_item(options)
+        Castle::API::ListItems::Unarchive.call(options)
+      end
+
+      # @param options [Hash]
+      def update_list_item(options = {})
+        Castle::API::ListItems::Update.call(options)
+      end
+    end
+  end
+end

data/lib/castle/client_actions/lists.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Castle
+  # Namespace for client actions
+  module ClientActions
+    # Client actions for lists
+    module Lists
+      # @param options [Hash]
+      def create_list(options = {})
+        Castle::API::Lists::Create.call(options)
+      end
+
+      # @param options [Hash]
+      def delete_list(options = {})
+        Castle::API::Lists::Delete.call(options)
+      end
+
+      # @param options [Hash]
+      def get_all_lists(options = {})
+        Castle::API::Lists::GetAll.call(options)
+      end
+
+      # @param options [Hash]
+      def get_list(options = {})
+        Castle::API::Lists::Get.call(options)
+      end
+
+      # @param options [Hash]
+      def query_lists(options = {})
+        Castle::API::Lists::Query.call(options)
+      end
+
+      # @param options [Hash]
+      def update_list(options = {})
+        Castle::API::Lists::Update.call(options)
+      end
+    end
+  end
+end

data/lib/castle/commands/list_items/archive.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    # Commands for list items endpoints
+    module ListItems
+      # Generates the payload for the DELETE /lists/:list_id/items/:item_id/archive request
+      class Archive
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[list_id list_item_id])
+
+            list_id = options.delete(:list_id)
+            list_item_id = options.delete(:list_item_id)
+
+            Castle::Command.new("lists/#{list_id}/items/#{list_item_id}/archive", nil, :delete)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/list_items/count.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module ListItems
+      # Generates the payload for the POST /lists/:list_id/items/count request
+      class Count
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[list_id])
+            options[:filters]&.each { |f| Castle::Validators::Present.call(f, %i[field op value]) }
+
+            list_id = options.delete(:list_id)
+
+            Castle::Command.new("lists/#{list_id}/items/count", options, :post)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/list_items/create.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module ListItems
+      # Builds the command to create a list item
+      class Create
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[list_id author primary_value])
+
+            list_id = options.delete(:list_id)
+
+            Castle::Command.new("lists/#{list_id}/items", options, :post)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/list_items/get.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module ListItems
+      # Builds the command to get a list item
+      class Get
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[list_id list_item_id])
+
+            list_id = options.delete(:list_id)
+            list_item_id = options.delete(:list_item_id)
+
+            Castle::Command.new("lists/#{list_id}/items/#{list_item_id}", nil, :get)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/list_items/query.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module ListItems
+      # Builds the command to query list items
+      class Query
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[list_id])
+            options[:filters]&.each { |f| Castle::Validators::Present.call(f, %i[field op value]) }
+            Castle::Validators::Present.call(options[:sort], %i[field order]) if options[:sort]
+
+            list_id = options.delete(:list_id)
+
+            Castle::Command.new("lists/#{list_id}/items/query", options, :post)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/list_items/unarchive.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module ListItems
+      # Builds the command to unarchive a list item
+      class Unarchive
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[list_id list_item_id])
+
+            list_id = options.delete(:list_id)
+            list_item_id = options.delete(:list_item_id)
+
+            Castle::Command.new("lists/#{list_id}/items/#{list_item_id}/unarchive", nil, :put)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/list_items/update.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module ListItems
+      # Builds the command to update a list item
+      class Update
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[list_id list_item_id comment])
+            list_id = options.delete(:list_id)
+            list_item_id = options.delete(:list_item_id)
+
+            Castle::Command.new("lists/#{list_id}/items/#{list_item_id}", options, :put)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/lists/create.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    # Commands for lists endpoints
+    module Lists
+      # Builds the command to create a list
+      class Create
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[name color primary_field])
+
+            Castle::Command.new('lists', options, :post)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/lists/delete.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module Lists
+      # Builds the command to delete a list
+      class Delete
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[list_id])
+
+            Castle::Command.new("lists/#{options[:list_id]}", nil, :delete)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/lists/get.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module Lists
+      # Builds the command to get a list
+      class Get
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[list_id])
+
+            Castle::Command.new("lists/#{options[:list_id]}", nil, :get)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/lists/get_all.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module Lists
+      # Builds the command to get all lists
+      class GetAll
+        class << self
+          # @return [Castle::Command]
+          def build
+            Castle::Command.new('lists', nil, :get)
+          end
+        end
+      end
+    end
+  end
+end