gotransverse-tract-api 0.7.4 → 0.7.5

data/lib/gotransverse-tract-api/usage/usage_lookup_table.rb

@@ -8,26 +8,35 @@ module GoTransverseTractApi
 
         #
         # @param {Long} eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_eid eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
+        def find_by_eid eid, options=nil
+          return nil unless eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({eid: eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
-        # @param {String} name
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Boolean} name
+        # @param {Hash} options
         #
-        def find_by_name name, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {name: name, queryScope: query_scope})
+        def find_by_name name, options=nil
+          return nil unless name.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({name: name}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} status
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_status status, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {status: status, queryScope: query_scope})
+        def find_by_status status, options=nil
+          return nil unless status.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({status: status}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
       end

data/lib/gotransverse-tract-api/usage/usage_lookup_table_entry.rb

@@ -8,34 +8,46 @@ module GoTransverseTractApi
 
         #
         # @param {Long} eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_eid eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
+        def find_by_eid eid, options=nil
+          return nil unless eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({eid: eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} usage_lookup_table_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_usage_lookup_table_eid usage_lookup_table_eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {usage_lookup_table_eid: usage_lookup_table_eid, queryScope: query_scope})
+        def find_by_usage_lookup_table_usage_lookup_table_eid usage_lookup_table_usage_lookup_table_eid, options=nil
+          return nil unless usage_lookup_table_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({usage_lookup_table_eid: usage_lookup_table_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} key
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_key key, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {key: key, queryScope: query_scope})
+        def find_by_key key, options=nil
+          return nil unless key.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({key: key}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} value
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_value value, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {value: value, queryScope: query_scope})
+        def find_by_value value, options=nil
+          return nil unless value.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({value: value}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
       end

data/lib/gotransverse-tract-api/usage/usage_price_category.rb

@@ -6,24 +6,34 @@ module GoTransverseTractApi
 
       class << self
 
-        def find_by_all 
-          GoTransverseTractApi.get_response_for(self)
+        #
+        # @param {Hash} options
+        #
+        def find_all options=nil
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_eid eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
+        def find_by_eid eid, options=nil
+          return nil unless eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({eid: eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
-        # @param {String} name
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Boolean} name
+        # @param {Hash} options
         #
-        def find_by_name name, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {name: name, queryScope: query_scope})
+        def find_by_name name, options=nil
+          return nil unless name.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({name: name}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
       end

data/lib/gotransverse-tract-api/usage/usage_rule.rb

@@ -8,18 +8,24 @@ module GoTransverseTractApi
 
         #
         # @param {Long} eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_eid eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
+        def find_by_eid eid, options=nil
+          return nil unless eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({eid: eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} service_period_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_service_period_eid service_period_eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {service_period_eid: service_period_eid, queryScope: query_scope})
+        def find_by_service_period_eid service_period_eid, options=nil
+          return nil unless service_period_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({service_period_eid: service_period_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
       end

data/lib/gotransverse-tract-api/version.rb

@@ -1,6 +1,6 @@
 module GoTransverseTractApi
 
-  VERSION = "0.7.4"
+  VERSION = "0.7.5"
   TARGET_API_VERSION = "1.29"
 
 end

data/spec/gotransverse-tract-api/order/sales_order_spec.rb

@@ -8,6 +8,26 @@ module GoTransverseTractApi
     let(:eid) { '296'}
     let(:response) { {a: 'b', c: 'd'} }
 
+    # As per TRACT documentation the API call exists
+    # but never works
+    describe ".find_all" do
+      context "when no options present" do
+        it "returns all sales orders" do
+          data = described_class.find_all
+          expect(data).to be_nil 
+        end
+      end
+
+      context "when options present" do
+        it "returns all sales orders based on options" do
+          options = { pageSize: 10, pageNumber: 2 }
+     
+          data = described_class.find_all options
+          expect(data).to be_nil 
+        end
+      end
+    end
+
     context ".find_by_eid" do
       it "returns a sales order for the given eid" do
         data = described_class.find_by_eid(eid)
@@ -15,6 +35,30 @@ module GoTransverseTractApi
       end
     end
 
+    describe ".find_by_account_num" do
+      it "returns nil if no account number is given" do
+        account_num = nil
+        options = {}
+
+        data = described_class.find_by_account_num(account_num, options)
+        expect(data).to be_nil 
+      end
+
+      it "returns a sales order for the given account number" do
+        account_num = 180
+        options = { pageSize: 100, pageNumber: 1, queryScope: 'DEEP' }
+
+        data = described_class.find_by_account_num(account_num, options)
+        expect(data).to_not be_nil 
+      end
+      it "returns a sales order for the given account number and no options" do
+        account_num = 180
+
+        data = described_class.find_by_account_num(account_num)
+        expect(data).to_not be_nil 
+      end
+    end
+
     context ".add_custom_field_value" do
       it "adds custom field value for the sales order" do
         data = { value: 'yes' }

data/spec/gotransverse-tract-api/product/product_spec.rb

@@ -21,7 +21,7 @@ module GoTransverseTractApi
 
     context ".find_by_name" do
       it "returns a product for the given name" do
-        data = described_class.find_by_name('Postcards 1st Class', 'DEEP')
+        data = described_class.find_by_name('Postcards 1st Class', {query_scope: 'DEEP'})
         expect(data).to_not be_nil 
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gotransverse-tract-api
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - Julien DeFrance
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,7 +184,6 @@ files:
 - lib/gotransverse-tract-api/product/product_price_range.rb
 - lib/gotransverse-tract-api/product/product_tag.rb
 - lib/gotransverse-tract-api/product/recurring_product_price.rb
-- lib/gotransverse-tract-api/product/usage_rule.rb
 - lib/gotransverse-tract-api/service/service.rb
 - lib/gotransverse-tract-api/service/service_device_inventory_item.rb
 - lib/gotransverse-tract-api/service/service_period.rb

data/lib/gotransverse-tract-api/product/usage_rule.rb

@@ -1,27 +0,0 @@
-module GoTransverseTractApi
-
-  module Product
-
-    class UsageRule
-
-      #
-      # @param {Long} eid
-      # @param {String} query_scope (default: 'SHALLOW')
-      #
-      def self.find_by_eid eid, query_scope=nil
-        GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
-      end
-
-      #
-      # @param {Long} service_period_eid
-      # @param {String} query_scope (default: 'SHALLOW')
-      #
-      def self.find_by_service_period_eid service_period_eid, query_scope=nil
-        GoTransverseTractApi.get_response_for(self, {service_period_eid: service_period_eid, queryScope: query_scope})
-      end
-
-    end
-
-  end
-
-end