envato 0.0.0 → 1.0.0

data/lib/envato/resource.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Envato
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+    alias delete_request delete
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/AbcSize
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Your request was malformed. #{response.body['error']}"
+      when 401
+        raise Error, "You did not supply valid authentication credentials. #{response.body['error']}"
+      when 403
+        raise Error, "You are not allowed to perform that action. #{response.body['error']}"
+      when 404
+        raise Error, "No results were found for your request. #{response.body['error']}"
+      when 429
+        raise Error, "Your request exceeded the API rate limit. #{response.body['error']}"
+      when 500
+        raise Error, "We were unable to perform the request due to server-side problems. #{response.body['error']}"
+      when 503
+        raise Error, "You have been rate limited for sending more  requests per second. #{response.body['error']}"
+      end
+
+      response
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+  end
+end

data/lib/envato/resources/bookmarks.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Envato
+  class BookmarksResource < Resource
+    def list
+      resp = get("v3/market/user/bookmarks")
+      Collection.from_response(resp, key: "bookmarks", type: UserBookmark)
+    end
+
+    # TODO: API error: "reason": "not-found"
+    def add(collection_id:, item_id:)
+      put("v3/market/user/bookmark_add?collection_id=#{collection_id}&item_id=#{item_id}")
+    end
+
+    def remove(id:)
+      delete("v3/market/user/bookmark_remove?id=#{id}")
+    end
+
+    # TODO: bookmarks_for_items
+    # TODO: item_ids: comma separated "12312312,123123123,12312312"
+    def for_items(item_ids:)
+      Object.new get("v3/market/user/bookmarks_for_items?item_ids=#{item_ids}").body
+    end
+
+    # TODO: add to CollectionResource
+    # TODO: API error: "reason": "not-found"
+    def collection_create(name:, site:, description:, is_public: false)
+      Object.new post("v3/market/user/collection_create \
+                        ?name=#{name}&site=#{site} \
+                        &public=#{is_public} \
+                        &description=#{description}".gsub(/\s+/, "")).body
+    end
+  end
+end

data/lib/envato/resources/item.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Envato
+  class ItemResource < Resource
+    def prices(item_id:)
+      resp = get("v1/market/item-prices:#{item_id}.json")
+      Collection.from_response(resp, key: "item-prices", type: ItemPrice)
+    end
+
+    def download(item_id:, purchase_code:, shorten_url: true)
+      Object.new get("v3/market/buyer/download \
+                        ?item_id=#{item_id} \
+                        &purchase_code=#{purchase_code} \
+                        &shorten_url=#{shorten_url}".gsub(/\s+/, "")).body
+    end
+
+    # TODO: filter_by: wordpress-plugins | wordpress-themes
+    def list_purchases(filter_by: "wordpress-themes", page: 1, details: false)
+      resp = get("v3/market/buyer/list-purchases \
+                    ?filter_by=#{filter_by} \
+                    &page=#{page} \
+                    &details=#{details}".gsub(/\s+/, ""))
+      Collection.from_response(resp, key: "results", type: Item)
+    end
+
+    def purchase(code:)
+      Object.new get("v3/market/buyer/purchase?code=#{code}").body
+    end
+
+    def purchases
+      resp = get("v3/market/buyer/purchases")
+      Collection.from_response(resp, key: "purchases", type: Item)
+    end
+
+    def version(id:)
+      ItemVersion.new get("v3/market/catalog/item-version?id=#{id}").body
+    end
+
+    def info(id:)
+      Item.new get("v3/market/catalog/item?id=#{id}").body
+    end
+  end
+end

data/lib/envato/resources/market.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Envato
+  class MarketResource < Resource
+    def user(username:)
+      Object.new get("v1/market/user:#{username}").body
+    end
+
+    # TODO: move methods to CategoriesResource
+    def categories(site:)
+      resp = get("v1/market/categories:#{site}.json")
+      Collection.from_response(resp, key: "categories", type: Category)
+    end
+
+    def categories_themeforest
+      categories(site: "themeforest")
+    end
+
+    def categories_photodune
+      categories(site: "photodune")
+    end
+
+    def categories_codecanyon
+      categories(site: "codecanyon")
+    end
+
+    def categories_videohive
+      categories(site: "videohive")
+    end
+
+    def categories_audiojungle
+      categories(site: "audiojungle")
+    end
+
+    def categories_graphicriver
+      categories(site: "graphicriver")
+    end
+
+    def categories_3docean
+      categories(site: "3docean")
+    end
+
+    # TODO: Features.new
+    def features(site:)
+      Object.new get("v1/market/features:#{site}.json").body
+    end
+
+    def features_themeforest
+      features(site: "themeforest")
+    end
+
+    def features_photodune
+      features(site: "photodune")
+    end
+
+    def features_codecanyon
+      features(site: "codecanyon")
+    end
+
+    def features_videohive
+      features(site: "videohive")
+    end
+
+    def features_audiojungle
+      features(site: "audiojungle")
+    end
+
+    def features_graphicriver
+      features(site: "graphicriver")
+    end
+
+    def features_3docean
+      features(site: "3docean")
+    end
+
+    def popular_items(site:)
+      Object.new get("v1/market/popular:#{site}.json").body
+    end
+
+    def popular_items_themeforest
+      popular_items(site: "themeforest")
+    end
+
+    def popular_items_photodune
+      popular_items(site: "photodune")
+    end
+
+    def popular_items_codecanyon
+      popular_items(site: "codecanyon")
+    end
+
+    def popular_items_videohive
+      popular_items(site: "videohive")
+    end
+
+    def popular_items_audiojungle
+      popular_items(site: "audiojungle")
+    end
+
+    def popular_items_graphicriver
+      popular_items(site: "graphicriver")
+    end
+
+    def popular_items_3docean
+      popular_items(site: "3docean")
+    end
+
+    # TODO: add themeforest, graphicriver, etc.
+    def new_files(site:, category:)
+      resp = get("v1/market/new-files:#{site},#{category}.json")
+      Collection.from_response(resp, key: "new-files", type: Item)
+    end
+
+    # TODO: add themeforest, etc.
+    def new_files_graphicriver(category:)
+      new_files(site: "graphicriver", category: category)
+    end
+
+    def new_files_from_user(username:, site:)
+      Object.new get("v1/market/new-files-from-user:#{username},#{site}.json")
+    end
+
+    def random_new_files(site:)
+      Object.new get("v1/market/random-new-files:#{site}.json")
+    end
+
+    def collection(id:, page: 1)
+      Object.new get("v3/market/catalog/collection?id=#{id}&page=#{page}").body
+    end
+  end
+end

data/lib/envato/resources/markets.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Envato
+  class MarketsResource < Resource
+    def number_of_files(site:)
+      Object.new get("v1/market/number-of-files:#{site}.json").body
+    end
+
+    def total_themeforest
+      number_of_files(site: "themeforest")
+    end
+
+    def total_photodune
+      number_of_files(site: "photodune")
+    end
+
+    def total_codecanyon
+      number_of_files(site: "codecanyon")
+    end
+
+    def total_videohive
+      number_of_files(site: "videohive")
+    end
+
+    def total_audiojungle
+      number_of_files(site: "audiojungle")
+    end
+
+    def total_graphicriver
+      number_of_files(site: "graphicriver")
+    end
+
+    def total_3docean
+      number_of_files(site: "3docean")
+    end
+
+    def total_items
+      Object.new get("v1/market/total-items.json").body
+    end
+    alias total total_items
+  end
+end

data/lib/envato/resources/search.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Envato
+  class SearchResource < Resource
+    def more_like_this(item_id:, page: 1, page_size: 10)
+      resp = get("v1/discovery/search/search/more_like_this?item_id=#{item_id}&page=#{page}&page_size=#{page_size}")
+      Collection.from_response(resp, key: "matches", type: Item)
+    end
+    alias like more_like_this
+
+    def comments(item_id:, page: 1, page_size: 10)
+      resp = get("v1/discovery/search/search/comment?item_id=#{item_id}&page=#{page}&page_size=#{page_size}")
+      Collection.from_response(resp, key: "matches", type: Comment)
+    end
+
+    def item
+      resp = get("v1/discovery/search/search/item")
+      Collection.from_response(resp, key: "matches", type: Item)
+    end
+  end
+end

data/lib/envato/resources/user.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Envato
+  class UserResource < Resource
+    def statement
+      UserStatement.new get("v3/market/user/statement").body
+    end
+
+    def collections
+      resp = get("v3/market/user/collections")
+      Collection.from_response(resp, key: "collections", type: UserCollection)
+    end
+
+    def collection(id:)
+      resp = get("v3/market/user/collection?id=#{id}")
+      Collection.from_response(resp, key: "items", type: CollectionItem)
+    end
+
+    def items(username:)
+      resp = get("v1/market/user-items-by-site:#{username}.json")
+      Collection.from_response(resp, key: "user-items-by-site", type: Item)
+    end
+
+    def badges(username:)
+      resp = get("v1/market/user-badges:#{username}.json")
+      Collection.from_response(resp, key: "user-badges", type: UserBadge)
+    end
+
+    def earnings_and_sales
+      Object.new get("v1/market/private/user/earnings-and-sales-by-month.json").body
+    end
+    alias sales_and_earnings earnings_and_sales
+
+    def account
+      UserAccount.new get("/v1/market/private/user/account.json").body
+    end
+
+    def name
+      Object.new get("v1/market/private/user/username.json").body
+    end
+    alias username name
+
+    def email
+      Object.new get("v1/market/private/user/email.json").body
+    end
+
+    def sales
+      Object.new get("v1/market/private/author/sales").body
+    end
+
+    def sale(code:)
+      UserSale.new get("v3/market/author/sale?code=#{code}").body
+    end
+
+    # TODO: rename and move to CollectionResource
+    def add_to_favorite(item_id:)
+      put("v3/market/user/favourite_collection_add?item_id=#{item_id}")
+    end
+  end
+end

data/lib/envato/resources/users.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Envato
+  class UsersResource < Resource
+    def total
+      UsersTotal.new get("v1/market/total-users.json").body
+    end
+    alias totat_users total
+  end
+end

data/lib/envato/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Envato
+  major = 1
+  minor = 0
+  patch = 0
+  VERSION = "#{major}.#{minor}.#{patch}"
+end

data/lib/envato.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "addressable/uri"
+require "faraday"
+require "envato/version"
+
+module Envato
+  autoload :Client, "envato/client"
+  autoload :Object, "envato/object"
+  autoload :Resource, "envato/resource"
+  autoload :Collection, "envato/collection"
+  autoload :Error, "envato/error"
+
+  autoload :UserResource, "envato/resources/user"
+  autoload :UsersResource, "envato/resources/users"
+  autoload :MarketResource, "envato/resources/market"
+  autoload :MarketsResource, "envato/resources/markets"
+  autoload :SearchResource, "envato/resources/search"
+  autoload :BookmarksResource, "envato/resources/bookmarks"
+  autoload :ItemResource, "envato/resources/item"
+
+  autoload :User, "envato/objects/types"
+  autoload :UserAccount, "envato/objects/types"
+  autoload :UserStatement, "envato/objects/types"
+  autoload :UserList, "envato/objects/types"
+  autoload :UserStatement, "envato/objects/types"
+  autoload :UserCollection, "envato/objects/types"
+  autoload :UserBookmark, "envato/objects/types"
+
+  autoload :UsersTotal, "envato/objects/types"
+
+  autoload :SearchMatch, "envato/objects/types"
+
+  autoload :CollectionItem, "envato/objects/types"
+
+  autoload :Item, "envato/objects/types"
+  autoload :ItemPrice, "envato/objects/types"
+  autoload :ItemVersion, "envato/objects/types"
+end

data/spec/bookmarks_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "envato"
+
+RSpec.describe "#bookmarks.list" do
+  subject(:resp) do
+    VCR.use_cassette("bookmarks_list") do
+      @envato.bookmarks.list
+    end
+  end
+
+  it { expect(resp).to be_instance_of(Envato::Collection) }
+  it { expect(resp.data.first).to be_instance_of(Envato::UserBookmark) }
+end

data/spec/envato_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "envato"
+
+RSpec.describe Envato::Client do
+  context "with valid token" do
+    describe "#user", :vcr do
+      it "name" do
+        allow(@envato.user)
+          .to receive(:name)
+          .and_return(Envato::UserResource)
+      end
+    end
+  end
+
+  context "without token" do
+    it do
+      expect { described_class.new }.to raise_error(ArgumentError)
+    end
+  end
+end
+
+RSpec.describe "#VERSION" do
+  it { expect(Envato::VERSION).to eq "1.0.0" }
+end

data/spec/item_spec.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "envato"
+
+RSpec.describe "#item.info" do
+  context "with id param" do
+    subject(:resp) do
+      VCR.use_cassette("item_info") do
+        @envato.item.info(id: "5556590")
+      end
+    end
+
+    it { expect(resp).to be_an(Envato::Item) }
+    it { expect(resp.tags).to be_an(Array) }
+    it { expect(resp.attributes).to be_an(Array) }
+    it { expect(resp.previews).to be_an(OpenStruct) }
+    it { expect(resp.site).to eq("themeforest.net") }
+  end
+
+  context "without id param" do
+    subject(:resp) do
+      VCR.use_cassette("item_info") do
+        @envato.item.info
+      end
+    end
+
+    it { expect { resp }.to raise_error(ArgumentError) }
+  end
+end
+
+RSpec.describe "#item.version" do
+  context "with id param" do
+    subject(:resp) do
+      VCR.use_cassette("item_version") do
+        @envato.item.version(id: "5556590")
+      end
+    end
+
+    it { expect(resp).to be_instance_of(Envato::ItemVersion) }
+  end
+
+  context "without id param" do
+    subject(:resp) do
+      VCR.use_cassette("item_version") do
+        @envato.item.version
+      end
+    end
+
+    it { expect { resp }.to raise_error(ArgumentError) }
+  end
+end
+
+RSpec.describe "#item.prices" do
+  context "with id param" do
+    subject(:resp) do
+      VCR.use_cassette("item_prices") do
+        @envato.item.prices(item_id: "5556590")
+      end
+    end
+
+    it { expect(resp).to be_instance_of(Envato::Collection) }
+    it { expect(resp.data.first).to be_instance_of(Envato::ItemPrice) }
+  end
+
+  context "without id param" do
+    it { expect { @envato.item.prices }.to raise_error(ArgumentError, /missing keyword/) }
+  end
+end
+
+RSpec.describe "#item.purchases" do
+  subject(:resp) do
+    VCR.use_cassette("item_purchases") do
+      @envato.item.purchases
+    end
+  end
+
+  it { expect(resp).to be_instance_of(Envato::Collection) }
+end
+
+RSpec.describe "#item.list_purchases" do
+  subject(:resp) do
+    VCR.use_cassette("item_list_purchases") do
+      @envato.item.list_purchases
+    end
+  end
+
+  it { expect(resp).to be_instance_of(Envato::Collection) }
+  it { expect(resp.data.count).to be_instance_of(Integer) }
+end

data/spec/market_spec.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "envato"
+
+RSpec.describe "#market.categories" do
+  context "when site is themeforest" do
+    subject(:resp) do
+      VCR.use_cassette("market_categories_themeforest") do
+        @envato.market.categories site: "themeforest"
+      end
+    end
+
+    it { expect(resp).to be_instance_of(Envato::Collection) }
+    it { expect(resp.data.first).to be_instance_of(Envato::Category) }
+    it { expect(resp.data.first.name).to eq "Site Templates" }
+    it { expect(resp.data.first.path).to eq "site-templates" }
+  end
+
+  context "when site is graphicriver" do
+    subject(:resp) do
+      VCR.use_cassette("market_categories_graphicriver") do
+        @envato.market.categories_graphicriver
+      end
+    end
+
+    it { expect(resp).to be_instance_of(Envato::Collection) }
+    it { expect(resp.data.first).to be_instance_of(Envato::Category) }
+    it { expect(resp.data.first.name).to eq "Graphics" }
+    it { expect(resp.data.first.path).to eq "graphics" }
+  end
+end
+
+RSpec.describe "#market.features" do
+  context "when site is themeforest" do
+    subject(:resp) do
+      VCR.use_cassette("market_features_themeforest") do
+        @envato.market.features site: "themeforest"
+      end
+    end
+
+    # TODO: Object to Features
+    it { expect(resp).to be_an(Envato::Object) }
+    it { expect(resp.features.free_file).to be_an OpenStruct }
+    it { expect(resp.features.featured_file).to be_an OpenStruct }
+    it { expect(resp.features.featured_author).to be_an OpenStruct }
+  end
+
+  context "when site is graphicriver" do
+    subject(:resp) do
+      VCR.use_cassette("market_features_graphicriver") do
+        @envato.market.features_graphicriver
+      end
+    end
+
+    it { expect(resp).to be_instance_of(Envato::Object) }
+    it { expect(resp.features.free_file).to be_an OpenStruct }
+    it { expect(resp.features.featured_file).to be_an OpenStruct }
+    it { expect(resp.features.featured_author).to be_an OpenStruct }
+  end
+end
+
+RSpec.describe "#market.new_files" do
+  context "when site is themeforest" do
+    subject(:resp) do
+      VCR.use_cassette("market_new_files") do
+        @envato.market.new_files(site: "themeforest", category: "site-templates")
+      end
+    end
+
+    it { expect(resp).to be_instance_of(Envato::Collection) }
+    it { expect(resp.data.first).to be_an OpenStruct }
+  end
+
+  context "when site is graphicriver" do
+    context "ant category is graphics" do
+      subject(:resp) do
+        VCR.use_cassette("market_new_files_graphicriver_graphics") do
+          @envato.market.new_files_graphicriver category: "graphics"
+        end
+      end
+
+      it { expect(resp).to be_instance_of(Envato::Collection) }
+      it { expect(resp.data.first).to be_an OpenStruct }
+    end
+  end
+end
+
+RSpec.describe "#market.popular_items" do
+  subject(:resp) do
+    VCR.use_cassette("market_popular_items_themeforest") do
+      @envato.market.popular_items site: "themeforest"
+    end
+  end
+
+  it { expect(resp).to be_instance_of(Envato::Object) }
+  it { expect(resp.popular).to be_instance_of(OpenStruct) }
+  it { expect(resp.popular.items_last_week).to be_instance_of(Array) }
+  it { expect(resp.popular.items_last_week.first.id).not_to be(nil) }
+end