usps-imis-api 0.6.12 → 0.6.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03dbc937f5336d48ede502436a3ddcee7d77f8f357d18d807ac4119b52acf7e8
-  data.tar.gz: 9052ead6d9fb967e5faadb730d7000f32d0e97e83545e60fdef7e9a0b3deda18
+  metadata.gz: ce718cab17b65f021cb739faa943d2437f2f4e83f051ad50c37a9ae0cfe48131
+  data.tar.gz: 34cece880ed383d43536f915b1c9480fe557587a61d69c9ed32c061932bbfd3a
 SHA512:
-  metadata.gz: 33d7ced678ecc240e405b73fe5ba6c006fedece86612f76018296166c53e8226996b27617fb1a7212f885c4a5107c9c03186ad922106ccc79714e6a522127fd9
-  data.tar.gz: 78b04d51fde868adf81b86231083bdafdb6f08a7f6e7664ba3406b65557be09bb875cc9f1c37846a353872f784cdc872506b27415150ad1b5f79363b5baf29aa
+  metadata.gz: a05b5e0bc67ac874b306e688decd19d61c28d4a734165817395f2194a5ac2e166c5e75bcfc900488036f83941c81b4fd0c840810a261813d8b2ae343d5597608
+  data.tar.gz: aa402f52a26d2eb0d44928d9461707bc671d6ebf4f3e85325407762d2529b09668b02c2970f58528ad125d1e36c87718439817307f676b0858d764ac358cc7df

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.6.12)
+    usps-imis-api (0.6.13)
       activesupport (~> 8.0)
 
 GEM

data/lib/usps/imis/api.rb

@@ -135,10 +135,10 @@ module Usps
       # An instance of +BusinessObject+, using this instance as its parent +Api+
       #
       # @param business_object_name [String] Name of the business object
-      # @param url_id [String] Override the ID param of the URL (e.g. used for Panels)
+      # @param ordinal [Integer] Ordinal to build override ID param of the URL (e.g. used for Panels)
       #
-      def business_object(business_object_name, url_id: nil)
-        BusinessObject.new(self, business_object_name, url_id:)
+      def business_object(business_object_name, ordinal: nil)
+        BusinessObject.new(self, business_object_name, ordinal:)
       end
 
       # Run requests as DSL, with specific +BusinessObject+ only maintained for this scope
@@ -146,15 +146,13 @@ module Usps
       # If no block is given, this returns the specified +BusinessObject+.
       #
       # @param business_object_name [String] Name of the business object
-      # @param url_id [String] Override the ID param of the URL (e.g. used for Panels)
+      # @param ordinal [Integer] Ordinal to build override ID param of the URL (e.g. used for Panels)
       #
-      def on(business_object_name, url_id: nil, &)
-        object = business_object(business_object_name, url_id:)
+      def on(business_object_name, ordinal: nil, &)
+        object = business_object(business_object_name, ordinal:)
         return object unless block_given?
 
-        result = nil
-        object.tap { |obj| result = obj.instance_eval(&) }
-        result
+        object.instance_eval(&)
       end
 
       # An instance of +Mapper+, using this instance as its parent +Api+

data/lib/usps/imis/business_object.rb

@@ -18,16 +18,16 @@ module Usps
       #
       attr_reader :business_object_name
 
-      # Override ID param of the URL (e.g. used for Panels)
+      # Ordinal to build override ID param of the URL (e.g. used for Panels)
       #
-      attr_reader :url_id
+      attr_reader :ordinal
 
       # A new instance of +BusinessObject+
       #
-      def initialize(api, business_object_name, url_id: nil)
+      def initialize(api, business_object_name, ordinal: nil)
         @api = api
         @business_object_name = business_object_name
-        @url_id = url_id
+        @ordinal = ordinal
       end
 
       # Get a business object for the current member
@@ -84,7 +84,7 @@ module Usps
       # @return [Hash] Response data from the API
       #
       def post(body)
-        request = Net::HTTP::Post.new(uri)
+        request = Net::HTTP::Post.new(uri(id: ''))
         request.body = JSON.dump(body)
         result = submit(uri, authorize(request))
         JSON.parse(result.body)
@@ -107,12 +107,20 @@ module Usps
 
       # Construct a business object API endpoint address
       #
-      def uri
-        id_for_url = url_id ? CGI.escape(url_id) : api.imis_id
-        full_path = "#{API_PATH}/#{business_object_name}/#{id_for_url}"
+      def uri(id: nil)
+        full_path = "#{API_PATH}/#{business_object_name}/#{id_for_uri(id)}"
         URI(File.join(Imis.configuration.hostname, full_path))
       end
 
+      # Select the correct ID to use in the URI
+      #
+      def id_for_uri(id = nil)
+        return CGI.escape(id) unless id.nil?
+        return CGI.escape("~#{api.imis_id}|#{ordinal}") if ordinal
+
+        api.imis_id
+      end
+
       # Manually assemble the matching data structure, with fields in the correct order
       #
       def filter_fields(fields)

data/lib/usps/imis/panel/base_panel.rb

@@ -20,7 +20,7 @@ module Usps
         # @param ordinal [Integer] The ordinal identifier for the desired object
         #
         def get(ordinal)
-          api.business_object(business_object, url_id: "~#{api.imis_id}|#{ordinal}").get
+          api.on(business_object, ordinal:).get
         end
 
         # Create a new object in the Panel
@@ -28,7 +28,7 @@ module Usps
         # @param data [Hash] The record data for the desired object
         #
         def create(data)
-          api.business_object(business_object, url_id: '').post(payload(data))
+          api.on(business_object).post(payload(data))
         end
 
         # Update an existing object in the Panel
@@ -37,9 +37,7 @@ module Usps
         #                    +ordinal+ identifier
         #
         def update(data)
-          api
-            .business_object(business_object, url_id: "~#{api.imis_id}|#{data[:ordinal]}")
-            .put(payload(data))
+          api.on(business_object, ordinal: data[:ordinal]).put(payload(data))
         end
 
         # Remove a specific object from the Panel
@@ -47,7 +45,7 @@ module Usps
         # @param ordinal [Integer] The ordinal identifier for the desired object
         #
         def destroy(ordinal)
-          api.business_object(business_object, url_id: "~#{api.imis_id}|#{ordinal}").delete
+          api.on(business_object, ordinal:).delete
         end
 
       private

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.6.12'
+    VERSION = '0.6.13'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.6.12
+  version: 0.6.13
 platform: ruby
 authors:
 - Julian Fiander