betsy 0.2.0

data/lib/betsy/shop_section.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Betsy
+  class ShopSection
+    include Betsy::Model
+
+    attribute :shop_section_id
+    attribute :title
+    attribute :rank
+    attribute :user_id
+    attribute :active_listing_count
+
+    def self.create_shop_section(shop_id, options = {})
+      make_request(:post, "/v3/application/shops/#{shop_id}/sections", options)
+    end
+
+    def self.get_shop_sections(shop_id)
+      make_request(:get, "/v3/application/shops/#{shop_id}/sections")
+    end
+
+    def self.get_shop_section(shop_id, shop_section_id)
+      make_request(:get, "/v3/application/shops/#{shop_id}/sections/#{shop_section_id}")
+    end
+  end
+end

data/lib/betsy/shop_shipping_profile.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Betsy
+  class ShopShippingProfile
+    include Betsy::Model
+
+    # Shipping Carriers
+    attribute :name
+    attribute :domestic_classes
+    attribute :international_classes
+
+    # Shop Shipping Profile
+    attribute :title
+    attribute :user_id
+    attribute :min_processing_days
+    attribute :max_processing_days
+    attribute :processing_days_display_label
+    attribute :origin_country_iso
+    attribute :is_deleted
+    attribute :shipping_profile_destinations
+    attribute :shipping_profile_upgrades
+    attribute :origin_postal_code
+    attribute :profile_type
+
+    # Shop Shipping Profile Destination
+    attribute :shipping_profile_destination_id
+    attribute :origin_country_iso
+    attribute :destination_country_iso
+    attribute :destination_region
+    attribute :primary_cost
+    attribute :secondary_cost
+
+    # Shop Shipping Profile Upgrade
+    attribute :upgrade_id
+    attribute :upgrade_name
+    attribute :type
+    attribute :rank
+    attribute :language
+    attribute :price
+    attribute :secondary_price
+
+    # Shared
+    attribute :shipping_carrier_id
+    attribute :shipping_profile_id
+    attribute :mail_class
+    attribute :min_delivery_days
+    attribute :max_delivery_days
+
+    def self.get_shipping_carriers(options = {})
+      make_request(:get, "/v3/application/shipping-carriers", options)
+    end
+
+    def self.create_shop_shipping_profile(shop_id, options = {})
+      make_request(:post, "/v3/application/shops/#{shop_id}/shipping-profiles", options)
+    end
+
+    def self.get_shop_shipping_profiles(shop_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/shipping-profiles", options)
+    end
+
+    def self.delete_shop_shipping_profile(shop_id, shipping_profile_id, options = {})
+      make_request(:delete, "/v3/application/shops/#{shop_id}/shipping-profiles/#{shipping_profile_id}", options)
+    end
+
+    def self.get_shop_shipping_profile(shop_id, shipping_profile_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/shipping-profiles/#{shipping_profile_id}", options)
+    end
+
+    def self.update_shop_shipping_profile(shop_id, shipping_profile_id, options = {})
+      make_request(:put, "/v3/application/shops/#{shop_id}/shipping-profiles/#{shipping_profile_id}", options)
+    end
+
+    def self.create_shop_shipping_profile_destination(shop_id, shipping_profile_id, options = {})
+      make_request(:post, "/v3/application/shops/1/shipping-profiles/1/destinations", options)
+    end
+
+    def self.get_shop_shipping_profile_destinations_by_shipping_profile(shop_id, shipping_profile_id, options = {})
+      make_request(:get, "/v3/application/shops/1/shipping-profiles/1/destinations", options)
+    end
+
+    def self.delete_shop_shipping_profile_destination(shop_id, shipping_profile_id, shipping_profile_destination_id, options = {})
+      make_request(:delete, "/v3/application/shops/#{shop_id}/shipping-profiles/#{shipping_profile_id}/destinations/#{shipping_profile_destination_id}", options)
+    end
+
+    def self.update_shop_shipping_profile_destination(shop_id, shipping_profile_id, shipping_profile_destination_id, options = {})
+      make_request(:put, "/v3/application/shops/#{shop_id}/shipping-profiles/#{shipping_profile_id}/destinations/#{shipping_profile_destination_id}", options)
+    end
+
+    def self.create_shop_shipping_profile_upgrade(shop_id, shipping_profile_id, options = {})
+      make_request(:post, "/v3/application/shops/#{shop_id}/shipping-profiles/#{shipping_profile_id}/upgrades", options)
+    end
+
+    def self.get_shop_shipping_profile_upgrades(shop_id, shipping_profile_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/shipping-profiles/#{shipping_profile_id}/upgrades", options)
+    end
+
+    def self.delete_shop_shipping_profile_upgrade(shop_id, shipping_profile_id, upgrade_id, options = {})
+      make_request(:delete, "/v3/application/shops/#{shop_id}/shipping-profiles/#{shipping_profile_id}/upgrades/#{upgrade_id}", options)
+    end
+
+    def self.update_shop_shipping_profile_upgrade(shop_id, shipping_profile_id, upgrade_id, options = {})
+      make_request(:put, "/v3/application/shops/#{shop_id}/shipping-profiles/#{shipping_profile_id}/upgrades/#{upgrade_id}", options)
+    end
+  end
+end

data/lib/betsy/user.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Betsy
+  class User
+    include Betsy::Model
+
+    attribute :user_id
+    attribute :login_name
+    attribute :primary_email
+    attribute :first_name
+    attribute :last_name
+    attribute :create_timestamp
+    attribute :referred_by_user_id
+    attribute :use_new_inventory_endpoints
+    attribute :is_seller
+    attribute :bio
+    attribute :gender
+    attribute :birth_month
+    attribute :birth_day
+    attribute :transaction_buy_count
+    attribute :transaction_sold_count
+
+    def self.get_user(user_id, options = {})
+      make_request(:get, "/v3/application/users/#{user_id}", options)
+    end
+  end
+end

data/lib/betsy/user_address.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Betsy
+  class UserAddress
+    include Betsy::Model
+
+    attribute :user_address_id
+    attribute :user_id
+    attribute :name
+    attribute :first_line
+    attribute :second_line
+    attribute :city
+    attribute :state
+    attribute :zip
+    attribute :iso_country_code
+    attribute :country_name
+    attribute :is_default_shipping_address
+
+    # STILL IN DEVELOPMENT AS OF 9/16/2021
+    def self.get_user_address
+    end
+
+    def self.get_user_addresses(options = {})
+      make_request(:get, "/v3/application/user/addresses", options)
+    end
+  end
+end

data/lib/betsy/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Betsy
+  VERSION = "0.2.0"
+end

data/lib/betsy.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "faraday"
+
+require_relative "betsy/version"
+require_relative "betsy/model"
+require_relative "betsy/shop"
+require_relative "betsy/seller_taxonomy"
+require_relative "betsy/shop_listing"
+require_relative "betsy/shop_listing_file"
+require_relative "betsy/shop_listing_image"
+require_relative "betsy/shop_listing_inventory"
+require_relative "betsy/shop_listing_offering"
+require_relative "betsy/shop_listing_product"
+require_relative "betsy/shop_listing_translation"
+require_relative "betsy/shop_listing_variation_image"
+require_relative "betsy/other"
+require_relative "betsy/ledger_entry"
+require_relative "betsy/payment"
+require_relative "betsy/shop_receipt"
+require_relative "betsy/shop_receipt_transaction"
+require_relative "betsy/review"
+require_relative "betsy/shop_shipping_profile"
+require_relative "betsy/shop_production_partner"
+require_relative "betsy/shop_section"
+require_relative "betsy/user"
+require_relative "betsy/user_address"
+require_relative "betsy/error"
+
+module Betsy
+  # class Error < StandardError; end
+
+  mattr_accessor :api_key
+  mattr_accessor :redirect_uri_base
+
+  ALL_SCOPES = ["address_r",
+    "address_w",
+    "billing_r",
+    "cart_r",
+    "cart_w",
+    "email_r",
+    "favorites_r",
+    "favorites_w",
+    "feedback_r",
+    "listings_d",
+    "listings_r",
+    "listings_w",
+    "profile_r",
+    "profile_w",
+    "recommend_r",
+    "recommend_w",
+    "shops_r",
+    "shops_w",
+    "transactions_r",
+    "transactions_w"]
+
+  CODE_CHALLENGE_CHARACTERS = ("A".."Z").to_a + ("a".."z").to_a + ("0".."9").to_a + [".", "_", "~", "-"]
+
+  def self.authorization_url(scope: ALL_SCOPES)
+    if api_key.nil? && redirect_uri_base.nil?
+      raise "Betsy.api_key and Betsy.redirect_uri_base must be set"
+    elsif api_key.nil?
+      raise "Betsy.api_key must be set"
+    elsif redirect_uri_base.nil?
+      raise "Betsy.redirect_uri_base must be set"
+    end
+
+    redirect_uri = "#{redirect_uri_base}/etsy_response_listener"
+    scope = scope.join("%20")
+    state = generate_state
+    code_verifier = generate_code_verifier
+    code_challenge = Digest::SHA256.base64digest(code_verifier).tr("+/", "-_").tr("=", "")
+
+    EtsyAccount.create(state: state, code_verifier: code_verifier)
+
+    "https://www.etsy.com/oauth/connect" \
+    "?response_type=code" \
+    "&client_id=#{api_key}" \
+    "&redirect_uri=#{redirect_uri}" \
+    "&scope=#{scope}" \
+    "&state=#{state}" \
+    "&code_challenge=#{code_challenge}" \
+    "&code_challenge_method=S256"
+  end
+
+  def self.request_access_token(params)
+    etsy_account = EtsyAccount.find_by(state: params[:state])
+    if etsy_account.present?
+      options = {
+        grant_type: "authorization_code",
+        client_id: api_key,
+        redirect_uri: "#{redirect_uri_base}/etsy_response_listener",
+        code: params[:code],
+        code_verifier: etsy_account.code_verifier
+      }
+      response = JSON.parse(Faraday.post("https://api.etsy.com/v3/public/oauth/token", options).body)
+      etsy_account.access_token = response["access_token"]
+      etsy_account.refresh_token = response["refresh_token"]
+      etsy_account.expires_in = response["expires_in"]
+      etsy_account.last_token_refresh = DateTime.now
+      etsy_account.save
+    else
+      raise "The state provided to /etsy_response_listener was an invalid state, this could be a sign of a CSRF attack"
+    end
+  end
+
+  class << self
+    private
+
+    def generate_state
+      (25...50).map { ("a".."z").to_a[rand(26)] }.join
+    end
+
+    def generate_code_verifier
+      (43...128).map { CODE_CHALLENGE_CHARACTERS[rand(CODE_CHALLENGE_CHARACTERS.count)] }.join
+    end
+  end
+end
+
+require_relative "betsy/engine" if defined?(Rails)

data/lib/generators/betsy/install_generator.rb

@@ -0,0 +1,35 @@
+require "rails/generators"
+require "rails/generators/migration"
+
+module Betsy
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "This creates all the initial files needed for the Betsy gem"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_betsy_model
+        template "etsy_account.rb", "app/models/etsy_account.rb"
+      end
+
+      def copy_betsy_migration
+        migration_template "create_etsy_accounts.rb", "db/migrate/create_etsy_accounts.rb", migration_version: migration_version
+      end
+
+      def copy_betsy_initalizer
+        template "betsy.rb", "config/initializers/betsy.rb"
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+    end
+  end
+end

data/lib/generators/betsy/templates/betsy.rb

@@ -0,0 +1,9 @@
+# Etsy API Key (keystring), this is the API key that you will use to access Etsy
+Betsy.api_key = "XXXXXXX"
+
+# Betsy this is the base URL for your application. 
+# When in production it will be something like "http://www.someurl.com".
+# When in development the best URL to use is "http://www.lvh.me:3000" 
+# since Etsy does not consider "localhost:3000" be a valid redirect URL.
+# Notice: Do your url should not include "/etsy_response_listener".
+Betsy.redirect_uri_base = "http://www.lvh.me:3000"

data/lib/generators/betsy/templates/create_etsy_accounts.rb

@@ -0,0 +1,14 @@
+class CreateEtsyAccounts < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :etsy_accounts do |t|
+      t.string :access_token
+      t.string :refresh_token
+      t.integer :expires_in
+      t.string :state
+      t.string :code_verifier
+      t.datetime :last_token_refresh
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/betsy/templates/etsy_account.rb

@@ -0,0 +1,2 @@
+class EtsyAccount < ApplicationRecord
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: betsy
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Jace Bayless
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+description: This gem allows users to simply interact with the Etsy V3 API.
+email:
+- jacebayless@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/betsy/response_listener_controller.rb
+- app/views/betsy/response_listener/etsy_response_listener.html.erb
+- betsy-0.1.0.gem
+- betsy.gemspec
+- bin/console
+- bin/setup
+- config/routes.rb
+- lib/betsy.rb
+- lib/betsy/engine.rb
+- lib/betsy/error.rb
+- lib/betsy/ledger_entry.rb
+- lib/betsy/model.rb
+- lib/betsy/other.rb
+- lib/betsy/payment.rb
+- lib/betsy/review.rb
+- lib/betsy/seller_taxonomy.rb
+- lib/betsy/shop.rb
+- lib/betsy/shop_listing.rb
+- lib/betsy/shop_listing_file.rb
+- lib/betsy/shop_listing_image.rb
+- lib/betsy/shop_listing_inventory.rb
+- lib/betsy/shop_listing_offering.rb
+- lib/betsy/shop_listing_product.rb
+- lib/betsy/shop_listing_translation.rb
+- lib/betsy/shop_listing_variation_image.rb
+- lib/betsy/shop_production_partner.rb
+- lib/betsy/shop_receipt.rb
+- lib/betsy/shop_receipt_transaction.rb
+- lib/betsy/shop_section.rb
+- lib/betsy/shop_shipping_profile.rb
+- lib/betsy/user.rb
+- lib/betsy/user_address.rb
+- lib/betsy/version.rb
+- lib/generators/betsy/install_generator.rb
+- lib/generators/betsy/templates/betsy.rb
+- lib/generators/betsy/templates/create_etsy_accounts.rb
+- lib/generators/betsy/templates/etsy_account.rb
+homepage: https://github.com/JaceBayless/betsy
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/JaceBayless/betsy
+  source_code_uri: https://github.com/JaceBayless/betsy
+  changelog_uri: https://github.com/JaceBayless/betsy/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.17
+signing_key: 
+specification_version: 4
+summary: A gem for the Etsy API V3
+test_files: []