tindie_api 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1779e3faf74733ae9d38c9e079b0cd48580d0b8d4d60524e653930b8bff4ba90
-  data.tar.gz: a030c9c6440f8ee5383ed0a9f7d41b1a29c9f569054aaa9d61c3d721df8cb52a
+  metadata.gz: 36daa88fb4fb4d1f4db8b756fed22867831dcbb78e41bdba37de2b7d27f38c92
+  data.tar.gz: aabeb3fdbf7fd8196f6ef426d4254581999f99f2b1980efbb83542dd164e36ff
 SHA512:
-  metadata.gz: 9805356be076b7d086d3ea557401ca2543f198f6ded69c5f858c1367c6620dee0936741e33a2c5c35dfbc22ebffe62b8036e552066fe662a821d0ac25feaccd6
-  data.tar.gz: 2d507819ce2ce35d0e910c283d513d04f62269af140bd260eaec0a5eb27311f0a410a327e0ccf07bf8cc2acd28b5be63c24ff010b28800089c4a984f3fe1ff53
+  metadata.gz: d7f25354104e21579d7982124b746041f9e0fb6178cd6f4412e4f480c3438e3ca31df521a13c805d285a1bcf497af8466c89efe1acd08db1be87c19f68df86a6
+  data.tar.gz: 264a53ac6ae677d480a9b98273ad5a8e80d4043d040a957e1ddb71671b0ffb2f970344ff5fb4792a2fd2c96fcfb8c89c97158d2d72c98df5c9b57ba7cf5f25a6

data/README.md

@@ -28,7 +28,7 @@ get "/orders" do
     @api = TindieApi::TindieOrdersAPI.new(@username, @api_key)
 
     # false means unshipped
-    orders = @api.get_orders_json(false)
+    orders = @api.get_all_orders(false)
 
     puts orders.inspect
 
@@ -36,6 +36,13 @@ get "/orders" do
 end
 ```
 
+Note that the Tindie api uses pagination with 20 items (default) and 50 items (max). 
+
+There are 3 ways to get orders depending on the level of abstraction you desire
+
+- `get_orders` (Returns TindieAPI Objects)  
+- `get_orders_json` (Returns Json)  
+- `get_all_orders` (Returns TindieAPI Objects)  
 
 ## Examples
 

data/lib/tindie_api/version.rb

@@ -1,3 +1,3 @@
 module TindieApi
-  VERSION = "0.1.9"
+  VERSION = "0.1.11"
 end

data/lib/tindie_api.rb

@@ -32,10 +32,9 @@ module TindieApi
     def initialize(data)
       @json_parsed = data
       @date = DateTime.parse(data['date'])
-      @date_shipped = DateTime.parse(data['date_shipped'])
       @products = data['items'].map { |i| TindieProduct.new(i) }
-      @shipped = data['shipped']
       @refunded = data['refunded']
+      @shipped = data['shipped']
       @order_number = data['number']
       @recipient_email = data['email']
       @recipient_phone = data['phone']
@@ -58,6 +57,7 @@ module TindieApi
       @tindie_fee = data['total_tindiefee']
       @cc_fee = data['total_ccfee']
       if @shipped
+        @date_shipped = DateTime.parse(data['date_shipped'])
         @tracking_code = data['tracking_code']
         @tracking_url = data['tracking_url']
       end
@@ -65,15 +65,20 @@ module TindieApi
   end
 
   class TindieOrdersAPI
+    MAX_ITEMS_PER_REQUEST = 50
+
     def initialize(username, api_key)
       @usr = username
       @api = api_key
       @cache = { false => nil, true => nil, nil => nil }
     end
 
-    def get_orders_json(shipped = nil)
+    def get_orders_json(shipped = nil, limit = nil, offset = nil)
       url = "https://www.tindie.com/api/v1/order/?format=json&api_key=#{@api}&username=#{@usr}"
       url += "&shipped=#{shipped}" unless shipped.nil?
+      url += "&limit=#{limit}" unless limit.nil?
+      url += "&offset=#{offset}" unless offset.nil?
+      
       uri = URI(url)
       response = Net::HTTP.get(uri)
       
@@ -85,13 +90,31 @@ module TindieApi
     rescue JSON::ParserError => e
       puts "Failed to parse JSON: #{response}"
       raise e
-    end      
+    end
 
     def get_orders(shipped = nil)
       raise ArgumentError, "shipped must be true, false, or nil" if !shipped.nil? && ![true, false].include?(shipped)
-      result = get_orders_json(shipped)['orders'].map { |i| TindieOrder.new(i) }
-      @cache[shipped] = [Time.now + EXPIRES_TIME, result]
-      result
+      result = get_orders_json(shipped)
+      orders = result['orders'].map { |i| TindieOrder.new(i) }
+      @cache[shipped] = [Time.now + EXPIRES_TIME, orders]
+      orders
+    end
+
+    def get_all_orders(shipped = nil)
+      results = []
+      offset = 0
+      
+      loop do
+        response = get_orders_json(shipped, MAX_ITEMS_PER_REQUEST, offset)
+        orders = response['orders'].map { |i| TindieOrder.new(i) }
+        results.concat(orders)
+        
+        break if response['meta'].nil? || response['meta']['next'].nil?
+        offset += MAX_ITEMS_PER_REQUEST
+        sleep(0.5)
+      end
+      
+      results
     end
 
     def _get_cache_(shipped = nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tindie_api
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Spencer Owen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-12-26 00:00:00.000000000 Z
+date: 2025-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler