tindie_api 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 112bc88a7cd40d984989ef332c81e0c4c1dfd827e02e5247632955a2c9613678
+  data.tar.gz: 18e04b2f25f5f385cff25c997a9ee3fa7e7aadf5cc8149bc5378642f7d18e0dc
+SHA512:
+  metadata.gz: acac5e238775d9444c3c4789fdb81946733093bc49550397fb662cba0b28cccc5dbd7ee6c813ff7aa44ae60281358245fc126cfe90dcc3453ac6f38d7f3763fc
+  data.tar.gz: be6790c2699cdaf08a104dd1147b0cf93a8ce9c762d2212a1c727dd5920ad60ff3c6d5624dcca29c7a879ef1ab856fca9d63bb4078a0ed66bf5b62d0703683b6

data/.github/workflows/gem-push.yml

@@ -0,0 +1,53 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+# on:
+#     push:
+#       branches: [ "main" ]
+#       paths:
+#         - 'lib/tindie_api/version.rb'
+#     pull_request:
+#       branches: [ "main" ]
+#       paths:
+#         - 'lib/tindie_api/version.rb'
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tindie_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Spencer Owen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# TindieApi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tindie_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tindie_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tindie_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tindie_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tindie_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tindie_api/version.rb

@@ -0,0 +1,3 @@
+module TindieApi
+  VERSION = "0.1.4"
+end

data/lib/tindie_api.rb

@@ -0,0 +1,115 @@
+require "tindie_api/version"
+require 'net/http'
+require 'json'
+require 'date'
+
+module TindieApi
+  class Error < StandardError; end
+
+  # Constants
+  EXPIRES_TIME = 3600 # 3600s = 1h
+
+  class TindieProduct
+    attr_reader :json_parsed, :model, :options, :qty, :sku, :unit_price, :price, :name
+
+    def initialize(data)
+      @json_parsed = data
+      @model = data['model_number']
+      @options = data['options']
+      @qty = data['quantity']
+      @sku = data['sku']
+      @unit_price = data['price_unit']
+      @price = data['price_total']
+      @name = data['product']
+    end
+  end
+
+  class TindieOrder
+    attr_reader :json_parsed, :date, :date_shipped, :products, :shipped, :refunded, :order_number,
+                :recipient_email, :recipient_phone, :address_dict, :address_str, :seller_payout,
+                :shipping_cost, :subtotal, :tindie_fee, :cc_fee, :tracking_code, :tracking_url
+
+    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']
+      @order_number = data['number']
+      @recipient_email = data['email']
+      @recipient_phone = data['phone']
+      @address_dict = {
+        city: data['shipping_city'],
+        country: data['shipping_country'],
+        recipient_name: data['shipping_name'],
+        instructions: data['shipping_instructions'],
+        postcode: data['shipping_postcode'],
+        service: data['shipping_service'],
+        state: data['shipping_state'],
+        street: data['shipping_street']
+      }
+      @address_str = "#{data['shipping_name']}\n#{data['shipping_street']}\n" \
+                     "#{data['shipping_city']} #{data['shipping_state']} #{data['shipping_postcode']}\n" \
+                     "#{data['shipping_country']}"
+      @seller_payout = data['total_seller']
+      @shipping_cost = data['total_shipping']
+      @subtotal = data['total_subtotal']
+      @tindie_fee = data['total_tindiefee']
+      @cc_fee = data['total_ccfee']
+      if @shipped
+        @tracking_code = data['tracking_code']
+        @tracking_url = data['tracking_url']
+      end
+    end
+  end
+
+  class TindieOrdersAPI
+    def initialize(username, api_key)
+      @usr = username
+      @api = api_key
+      @cache = { false => nil, true => nil, nil => nil }
+    end
+
+    def get_orders_json(shipped = nil)
+      url = "https://www.tindie.com/api/v1/order/?format=json&api_key=#{@api}&username=#{@usr}"
+      url += "&shipped=#{shipped}" unless shipped.nil?
+      uri = URI(url)
+      response = Net::HTTP.get(uri)
+      JSON.parse(response)
+    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
+    end
+
+    def _get_cache_(shipped = nil)
+      elem = @cache[shipped]
+      return get_orders(shipped) if elem.nil? || elem[0] < Time.now
+      elem[1]
+    end
+
+    def get_last_order
+      _get_cache_.first
+    end
+
+    def average_order_revenue(limit = 20)
+      orders = _get_cache_.take(limit)
+      orders.sum(&:seller_payout) / orders.size.to_f
+    end
+
+    def average_order_shipping(limit = 20)
+      orders = _get_cache_.take(limit)
+      orders.sum(&:shipping_cost) / orders.size.to_f
+    end
+
+    def average_order_timedelta(limit = 20)
+      orders = _get_cache_.take(limit + 1)
+      total_time = orders.each_cons(2).sum { |a, b| a.date - b.date }
+      total_time / [limit, orders.size - 1].min
+    end
+  end
+end

data/tindie_api.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tindie_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tindie_api"
+  spec.version       = TindieApi::VERSION
+  spec.authors       = ["Spencer Owen"]
+  spec.email         = ["owenspencer@gmail.com"]
+
+  spec.summary       = %q{Ruby Library to interact with tindie.com api}
+  spec.description   = %q{Ruby Library to interact with tindie.com api}
+  spec.homepage      = "https://github.com/spuder/tindie_api"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/spuder/tindie_api"
+    spec.metadata["changelog_uri"] = "https://github.com/spuder/tindie_api"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: tindie_api
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Spencer Owen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Ruby Library to interact with tindie.com api
+email:
+- owenspencer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tindie_api.rb
+- lib/tindie_api/version.rb
+- tindie_api.gemspec
+homepage: https://github.com/spuder/tindie_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/spuder/tindie_api
+  source_code_uri: https://github.com/spuder/tindie_api
+  changelog_uri: https://github.com/spuder/tindie_api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Ruby Library to interact with tindie.com api
+test_files: []