envato 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0803d16509a393c20d289dad31220711faccadd9cc5b03821d0c6a24f297fa33'
-  data.tar.gz: 7439e670daa5fb74d6c96809ea72772c0acec9acb90d5dff797f6d360e2e1374
+  metadata.gz: d218714f8633fe293e92eae29201a5f3e43713237f167ccca14786eccd2a6441
+  data.tar.gz: 7edab5418e1e89d7077e56e1b9919c26e3981c0108b0c532aacf3be9ab8c3715
 SHA512:
-  metadata.gz: 5f4b0c6b832f601d7e4bc5be400b3382a31e1be402119f12794ec8de37f57fd173edc8566175a3a6e25886d039b3481c64dd51f2efc30c063afa7c033f866660
-  data.tar.gz: 436335c438e3842e1c5b3930de468669496a4a28a5a7d17444d5f5fd8ad161c6f9b2ffabab1617fbce790de2c2ef7b4064e1deb8e4b881f90f3b395640498b58
+  metadata.gz: 8eadf73abe33a300e4d20e3d53fac5ca1b8fa30cac3561c0676a489e265afaa5991a26f0afb53fcce5b7de3623f3455cd8d747717bd3074118cdfd87fb7c50cb
+  data.tar.gz: 61fdb4c1bac7b49ccb01fccdc6f2f562a37f93ee7c4952bdcd63752c97988a8f72fc4f8133afb90a7177022372a51b3beb31427d40d7a0a9081e9f02c25367c0

data/.gitignore

@@ -0,0 +1,46 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+## macos
+.DS_Store
+dev
+
+# TODO: remove from ignore list
+api_endpoints.json
+api.sh
+
+fixtures
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,5 @@
+--tty
+--color
+--format documentation # progress
+--backtrace
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,142 @@
+---
+AllCops:
+  NewCops: disable # TODO: change to enable after refactoring
+
+# Commonly used screens these days easily fit more than 80 characters.
+Layout/LineLength:
+  Max: 120
+
+# Too short methods lead to extraction of single-use methods, which can make
+# the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength: 
+  Max: 20
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# Single quotes being faster is hardly measurable and only affects parse time.
+# Enforcing double quotes reduces the times where you need to change them
+# when introducing an interpolation. Use single quotes only if their semantics
+# are needed.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+# Most readable form.
+Style/OptionHash:
+  # A list of parameter names that will be flagged by this cop.
+  SuspiciousParamNames:
+    - options
+    - opts
+    - args
+    - paramsgit sttus
+    - parameters
+
+# Mixing the styles looks just silly.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# has_key? and has_value? are far more readable than key? and value?
+Style/PreferredHashMethods:
+  Enabled: false
+
+# String#% is by far the least verbose and only object oriented variant.
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    # inject seems more common in the community.
+    reduce: "inject"
+
+
+# Either allow this style or don't. Marking it as safe with parenthesis
+# is silly. Let's try to live without them for now.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# A specialized exception class will take one or more arguments and construct the message from it.
+# So both variants make sense. 
+Style/RaiseArgs:
+  Enabled: false
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# The argument that fail should be used to abort the program is wrong too,
+# there's Kernel#abort for that.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Suppressing exceptions can be perfectly fine, and be it to avoid to
+# explicitly type nil into the rescue since that's what you want to return,
+# or suppressing LoadError for optional dependencies
+Lint/SuppressedException:
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  # The space here provides no real gain in readability while consuming
+  # horizontal space that could be used for a better parameter name.
+  # Also {| differentiates better from a hash than { | does.
+  SpaceBeforeBlockParameters: false
+
+# No trailing space differentiates better from the block:
+# foo} means hash, foo } means block.
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Enforcing the names of variables? To single letter ones? Just no.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Shadowing outer local variables with block parameters is often useful
+# to not reinvent a new name for the same thing, it highlights the relation
+# between the outer variable and the parameter. The cases where it's actually
+# confusing are rare, and usually bad for other reasons already, for example
+# because the method is too long.
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Check with yard instead.
+Style/Documentation:
+  Enabled: false 
+
+# This is just silly. Calling the argument `other` in all cases makes no sense.
+Naming/BinaryOperatorParameterName:
+  Enabled: false 
+
+# There are valid cases, for example debugging Cucumber steps,
+# also they'll fail CI anyway
+Lint/Debugger:
+  Enabled: false
+
+# Style preference
+Style/MethodDefParentheses:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    envato (1.0.0)
+      addressable (~> 2.3, >= 2.3.7)
+      faraday (~> 1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (1.10.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    hashdiff (1.0.1)
+    multipart-post (2.2.3)
+    public_suffix (5.0.0)
+    rake (13.0.6)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  universal-darwin-21
+
+DEPENDENCIES
+  bundler
+  envato!
+  rake (>= 10)
+  rspec (>= 3.0)
+  simplecov (>= 0.9)
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.3.22

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2022 Ilya Brin
+
+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,152 @@
+# Envato API - Ruby client ([gem](https://rubygems.org/gems/envato))
+
+## TODO
+
+- examples
+- documentation
+- tests
+
+# Available methods
+
+### V1 requests
+```ruby
+# get /search/more_like_this
+# GET https://api.envato.com/v1/discovery/search/search/more_like_this
+client.search.more_like_this(item_id:, page: 1, page_size: 10)
+
+# get /search/comment
+# GET https://api.envato.com/v1/discovery/search/search/comment
+client.search.comment(item_id:)
+
+# get /search/item
+# GET https://api.envato.com/v1/discovery/search/search/item
+client.search.item
+
+# get /number-of-files:{site}.json
+# GET https://api.envato.com/v1/market/number-of-files:{site}.json
+client.market.number_of_files(site:) # eg. "themeforest"
+
+# get /total-users.json
+# GET https://api.envato.com/v1/market/total-users.json
+client.users.total
+
+# get /total-items.json
+# GET https://api.envato.com/v1/market/total-items.json
+client.items.total
+
+# get /item-prices:{item_id}.json
+# GET https://api.envato.com/v1/market/item-prices:{item_id}.json
+client.market.item_proces(item_id:)
+
+
+# get /user:{username}.json
+# GET https://api.envato.com/v1/market/user:{username}.json
+client.users.info(username:)
+
+# get /user-items-by-site:{username}.json
+# GET https://api.envato.com/v1/market/user-items-by-site:{username}.json
+client.users.items_by_site(username:)
+
+# get /popular:{site}.json
+# GET https://api.envato.com/v1/market/popular:{site}.json
+client.market.popular(site:)
+
+# get /categories:{site}.json
+# GET https://api.envato.com/v1/market/categories:{site}.json
+client.categories.list(site:)
+
+# get /features:{site}.json
+# GET https://api.envato.com/v1/market/features:{site}.json
+client.features.list(site:)
+
+# get /new-files:{site,category}.json
+# GET https://api.envato.com/v1/market/new-files:{site,category}.json
+client.new_files.list(site:)
+
+# get /new-files-from-user:{username,site}.json
+# GET https://api.envato.com/v1/market/new-files-from-user:{username,site}.json
+client.users.new_fileslist(username:, site:)
+
+# get /random-new-files:{site}.json
+# GET https://api.envato.com/v1/market/random-new-files:{site}.json
+client.market.random_new_files(site:)
+
+# get /user-badges:{username}.json
+# GET https://api.envato.com/v1/market/user-badges:{username}.json
+client.users.badges(username:)
+
+# get /private/user/earnings-and-sales-by-month.json
+# GET https://api.envato.com/v1/market/private/user/earnings-and-sales-by-month.json
+client.user.money_stats
+
+get /private/user/account.json
+GET https://api.envato.com/v1/market/private/user/account.json
+client.user.account
+
+get /private/user/username.json
+GET https://api.envato.com/v1/market/private/user/username.json
+client.user.name
+
+get /private/user/email.json
+GET https://api.envato.com/v1/market/private/user/email.json
+client.user.email
+
+### V3 requests
+get /author/sales
+GET https://api.envato.com/v3/market/author/sales
+
+get /author/sale?sale=
+https://api.envato.com/v3/market/author/sale
+
+
+get /buyer/download
+GET https://api.envato.com/v3/market/buyer/download
+
+get /buyer/list-purchases
+GET https://api.envato.com/v3/market/buyer/list-purchases
+
+get /buyer/purchase?code=
+GET https://api.envato.com/v3/market/buyer/purchase
+
+get /buyer/purchases
+GET https://api.envato.com/v3/market/buyer/purchases
+
+get /catalog/collection?id=
+GET https://api.envato.com/v3/market/catalog/collection
+
+get /catalog/item-version?id=
+GET https://api.envato.com/v3/market/catalog/item-version
+
+get /catalog/item?id=
+GET https://api.envato.com/v3/market/catalog/item
+
+put /user/bookmark_add?collectionid=&item_id=
+PUT https://api.envato.com/v3/market/user/bookmark_add?collectionid=&item_id=
+
+delete /user/bookmark_remove
+DELETE https://api.envato.com/v3/market/user/bookmark_remove?id=
+
+get /user/bookmarks_for_items?item_ids=123,1234,567
+GET https://api.envato.com/v3/market/user/bookmarks_for_items
+
+get /user/bookmarks - OK
+GET https://api.envato.com/v3/market/user/bookmarks
+
+post /user/collection_create?name=
+POST https://api.envato.com/v3/market/user/collection_create
+
+get /user/collection?id=
+GET https://api.envato.com/v3/market/user/collection
+
+get /user/collections - OK
+GET https://api.envato.com/v3/market/user/collections
+client.user.collections
+
+put /user/favourite_collection_add?item_id=
+PUT https://api.envato.com/v3/market/user/favourite_collection_add?item_id=
+client.user.
+
+get /user/statement - OK
+GET https://api.envato.com/v3/market/user/statement
+client.user.statement
+```

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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
+
+task :console do
+  exec "irb -I lib -r envato.rb"
+end

data/envato.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "envato/version"
+
+Gem::Specification.new do |s|
+  s.name          = "envato"
+  s.version       = Envato::VERSION
+  s.summary       = "WIP - Envato API client"
+  s.description   = "WIP - Envato API wrapper written in Ruby"
+  s.authors       = ["Ilya Brin"]
+  s.email         = "ilya@codeplay.ru"
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) {|f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.homepage      = "https://github.com/ruby-api-client/envato"
+  s.license       = "MIT"
+
+  s.required_ruby_version = ">= 2.6"
+
+  s.metadata["rubygems_mfa_required"] = "true"
+
+  s.add_dependency "addressable", "~> 2.3", ">= 2.3.7"
+  s.add_dependency "faraday", "~> 1.7"
+
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake", ">= 10"
+  s.add_development_dependency "rspec", ">= 3.0"
+  s.add_development_dependency "simplecov", ">= 0.9"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "webmock"
+end

data/lib/envato/client.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Envato
+  class Client
+    BASE_URL = "https://api.envato.com"
+
+    attr_reader :token, :adapter
+
+    def initialize(token:, adapter: Faraday.default_adapter, stubs: nil)
+      @token = token
+      @adapter = adapter
+      @stubs = stubs # Test stubs for requests
+    end
+
+    def user
+      UserResource.new(self)
+    end
+
+    def users
+      UsersResource.new(self)
+    end
+
+    def search
+      SearchResource.new(self)
+    end
+
+    def market
+      MarketResource.new(self)
+    end
+
+    def markets
+      MarketsResource.new(self)
+    end
+
+    def bookmarks
+      BookmarksResource.new(self)
+    end
+
+    def item
+      ItemResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.request :authorization, :Bearer, token
+        conn.request :json
+        conn.request :url_encoded
+
+        conn.response :json, content_type: "application/json"
+
+        conn.adapter adapter, @stubs
+      end
+    end
+  end
+end

data/lib/envato/collection.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Envato
+  class Collection
+    # TODO: links: { next_page_url, prev_page_url, first_page_url, last_page_url }
+    # TODO: total_hits:
+    # TODO: took:
+    attr_reader :data, :items, :total
+
+    def self.from_response(response, key:, type:)
+      body = response.body
+      new(
+        data: body[key].map {|attrs| type.new(attrs) },
+        items: body["items"],
+        total: body["total"]
+      )
+    end
+
+    def initialize(data:, items:, total:)
+      @data   = data
+      @items  = items
+      @total  = total
+    end
+  end
+end

data/lib/envato/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Envato
+  class Error < StandardError
+  end
+end

data/lib/envato/object.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module Envato
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    # Convert Array or Hash to OpenStruct
+    def to_ostruct(obj)
+      case obj
+      when Hash
+        # rubocop:disable Style/HashTransformValues
+        OpenStruct.new(obj.map {|key, val| [key, to_ostruct(val)] }.to_h)
+        # rubocop:enable Style/HashTransformValues
+      when Array
+        obj.map {|o| to_ostruct(o) }
+      else
+        obj
+      end
+    end
+  end
+end

data/lib/envato/objects/types.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Envato
+  class User < Object; end
+  class Users < Object; end
+  class UsersTotal < Object; end
+  class UserSale < Object; end
+  class UserAccount < Object; end
+  class UserStatement < Object; end
+  class UserCollection < Object; end
+  class UserBookmark < Object; end
+  class UserBadge < Object; end
+  class Item < Object; end
+  class ItemPrice < Object; end
+  class ItemVersion < Object; end
+  class CollectionItem < Object; end
+  class Comment < Object; end
+  class Category < Object; end
+end