envato-sdk 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85318723cad8842630347db996fba2bb15679468
-  data.tar.gz: cd6b0c2933e13590c1a2e8400c9754d6693c8507
+  metadata.gz: 161e6a8f05ab1d5cd4085bbfa404d043fcc468d5
+  data.tar.gz: 3f24c8df1c6018e93c3ba47716cdfe279505d94b
 SHA512:
-  metadata.gz: bd76aa40eb91c2c2e7921fa21513b255b9259ac93338155a2a7472064f4f2c58ec6efe76de1fbc64f4228f31a85d4a49c1964c8a2a65e267974b51e8392e6d4a
-  data.tar.gz: 7b73db2a5f16b45e86e30ad390d5cba82f5ae9161b318f871ed7bf9af3a40889d9dd7d126f0ac64fd1a8e5af00290c987bc602047d18ab906512e8be3d33ca73
+  metadata.gz: e2ad00c1d5d6d43e930afbde208ecd46027c67966666810aab9c635f65941d87e010db71636e80cf97fa25646eccaf8cf5e64226b4fe67f9cea3727b7d2de970
+  data.tar.gz: 01a0f5e0fe558024a1886b3d4aa7c2a52ba92265e1a39ed02bae3de5fef4b8c8514771562dc1fe23b7dac3476f435af45d258ab700ae615bca2799671762184e

data/README.md

@@ -29,26 +29,87 @@ response = client.get 'market/total-users.json'
 # => {"total-users"=>{"total_users"=>"5942654"}}
 ```
 
-## Available endpoints
+## Examples
 
 Here is a list of the functionality available via this gem. All examples expect
 that you have already created a client called `client` as seen in the above
-example.
+example. `...` represents multiple of the previous item repeated such as a hash
+or array item.
 
-- [total_items](https://build.envato.com/api/#market_TotalItems)
+#### User
 
+- [`account_details`](https://build.envato.com/api/#market_Account)
+
+  ```rb
+  client.account_details
+  # => {"image"=>"https://0.s3.envato.com/files/144155428/avatar.jpg", "firstname"=>"Jacob", "surname"=>"Bednarz", "available_earnings"=>"0.00", "total_deposits"=>"0.00", "balance"=>"0.00", "country"=>"Australia"}
+  ```
+
+- [`username`](https://build.envato.com/api/#market_Username)
+
+  ```rb
+  client.username
+  # => 'jacobbednarz'
+  ```
+
+- [`email_address`](https://build.envato.com/api/#market_Email)
+
+  ```rb
+  client.email_address
+  # => 'jacob@envato.com'
+  ```
+
+- [`user_information`](https://build.envato.com/api/#market_User)
+
+  ```rb
+  client.user_information('jacobbednarz')
+  # => {"username": "jacobbednarz","country": "Australia","sales": "0","location": "","image": "https://0.s3.envato.com/files/144155428/avatar.jpg","followers": "4"}
+  ```
+
+- [`badges_for_user`](https://build.envato.com/api/#market_UserBadges)
+
+  ```rb
+  client.badges_for_user('jacobbednarz')
+  # => [{"name"=>"country_au", "label"=>"Australia", "image"=>"https://dmypbau5frl9g.cloudfront.net/assets/badges/country_au-53dc340a932f5b9f1d1db574fb6712b4.svg"}, {"name"=>"envato_team", "label"=>"Envato Team", "image"=>"https://dmypbau5frl9g.cloudfront.net/assets/badges/envato_team-ac987db51c92549046fa25dfb7259bf9.svg"}, {"name"=>"exclusive", "label"=>"Exclusive Author", "image"=>"https://dmypbau5frl9g.cloudfront.net/assets/badges/exclusive-f7d9bbcda891f9ad25f00da4ea099435.svg"}]
   ```
+
+- [`user_items_by_site`](https://build.envato.com/api/#market_UserItemsBySite)
+
+  ```rb
+  client.user_items_by_site('collis')
+  # => [{"site"=>"ThemeForest", "items"=>"1"}, {"site"=>"Tuts+ Marketplace", "items"=>"2"}]
+  ```
+
+- [`new_items_for_user`](https://build.envato.com/api/#market_NewFilesFromUser)
+
+  ```rb
+  client.new_items_for_user('collis', 'themeforest')
+  # => [{"id"=>"22705", "item"=>"Black + White Simple Theme", "url"=>"http://themeforest.net/item/black-white-simple-theme/22705", "user"=>"collis", "thumbnail"=>"https://preview-tf.s3.envato.com/files/60223.jpg", "sales"=>"916", "rating"=>"4.5", "rating_decimal"=>"4.32", "cost"=>"8.00", "uploaded_on"=>"Tue Dec 02 04:01:12 +1100 2008", "last_update"=>"", "tags"=>"clean", "category"=>"psd-templates/creative", "live_preview_url"=>"https://0.s3.envato.com/files/60224/1_home.__large_preview.jpg"}]
+  ```
+
+#### Marketplace Stats
+
+- [`total_items`](https://build.envato.com/api/#market_TotalItems)
+
+  ```rb
   client.total_items
   # => 12345
   ```
 
-- [total_users](https://build.envato.com/api/#market_TotalUsers)
+- [`total_users`](https://build.envato.com/api/#market_TotalUsers)
 
-  ```
+  ```rb
   client.total_users
   # => 23456
   ```
 
+- [`category_information_by_site`](https://build.envato.com/api/#market_NumberOfFiles)
+
+  ```rb
+  client.category_information_by_site('themeforest')
+  # => [{"category"=>"Site Templates","number_of_files"=>"6551","url"=>"http://themeforest.net/category/site-templates"}, ... ]
+  ```
+
 ## Testing
 
 RSpec is the testing tool of choice and you can kick off the test suite by
@@ -92,6 +153,9 @@ It's super important you use real credentials when re-generating the cassettes
 to ensure it is an accurate representation of the interactions. (Don't worry, we
 don't commit your details to the cassettes they are filtered out by VCR!)
 
+Note: Do not use the value of `ENVATO_TEST_API_USERNAME` in any of your tests
+where it is passed into the URL. This will cause VCR not to create the cassette
+due to the `ENVATO_TEST_API_USERNAME` being replaced during sanitisation.
 ## Releasing a new version
 
 Everything you need to build a new release can be done by running:

data/lib/envato/client.rb

@@ -1,6 +1,7 @@
 require 'envato/connection'
 require 'envato/configurable'
 require 'envato/client/stats'
+require 'envato/client/user'
 
 module Envato
   class Client
@@ -8,6 +9,7 @@ module Envato
     include Envato::Connection
     include Envato::Configurable
     include Envato::Client::Stats
+    include Envato::Client::User
 
     def initialize(options = {})
       Envato::Configurable.keys.each do |key|
@@ -29,6 +31,17 @@ module Envato
       inspected
     end
 
+    # Public: Conceal a sensitive string.
+    #
+    # This conceals everything in a string except for the first and last 4
+    # characters. Useful to hide sensitive data without removing it completely.
+    #
+    # Examples
+    #
+    #   conceal('secretstring')
+    #   # => 'secr****ring'
+    #
+    # Returns a String.
     def conceal(string)
       if string.length < 8
         '****'
@@ -38,5 +51,15 @@ module Envato
         "#{front}****#{back}"
       end
     end
+
+    private
+
+    def marketplace_names
+      %w(graphicriver themeforest activeden codecanyon videohive audiojungle photodune 3docean)
+    end
+
+    def marketplace_domains
+      marketplace_names.map { |domain| "#{domain}.net" }
+    end
   end
 end

data/lib/envato/client/stats.rb

@@ -2,14 +2,21 @@ module Envato
   class Client
     module Stats
       def total_users
-        response = get 'market/total-users.json'
+        response = get 'v1/market/total-users.json'
         response['total-users']['total_users'].to_i
       end
 
       def total_items
-        response = get 'market/total-items.json'
+        response = get 'v1/market/total-items.json'
         response['total-items']['total_items'].to_i
       end
+
+      def category_information_by_site(sitename)
+        raise Envato::InvalidSiteName unless marketplace_names.include? sitename
+
+        response = get "v1/market/number-of-files:#{sitename}.json"
+        response['number-of-files']
+      end
     end
   end
 end

data/lib/envato/client/user.rb

@@ -0,0 +1,42 @@
+module Envato
+  class Client
+    module User
+      def account_details
+        response = get 'v1/market/private/user/account.json'
+        response['account']
+      end
+
+      def username
+        response = get 'v1/market/private/user/username.json'
+        response['username']
+      end
+
+      def email_address
+        response = get 'v1/market/private/user/email.json'
+        response['email']
+      end
+
+      def user_information(username)
+        response = get "v1/market/user:#{username}.json"
+        response['user']
+      end
+
+      def badges_for_user(username)
+        response = get "v1/market/user-badges:#{username}.json"
+        response['user-badges']
+      end
+
+      def user_items_by_site(username)
+        response = get "v1/market/user-items-by-site:#{username}.json"
+        response['user-items-by-site']
+      end
+
+      def new_items_for_user(username, sitename)
+        raise Envato::InvalidSiteName unless marketplace_names.include? sitename
+
+        response = get "v1/market/new-files-from-user:#{username},#{sitename}.json"
+        response['new-files-from-user']
+      end
+    end
+  end
+end

data/lib/envato/connection.rb

@@ -15,10 +15,6 @@ module Envato
       'https://api.envato.com'
     end
 
-    def api_version
-      'v1'
-    end
-
     private
 
     def request(method, url, options = {})
@@ -31,7 +27,7 @@ module Envato
 
       case method
       when :get
-        response = request.get "#{api_version}/#{url}"
+        response = request.get(url)
       end
 
       case response.status.to_i

data/lib/envato/errors.rb

@@ -9,4 +9,8 @@ module Envato
   class NotFoundError < Error; end
   class ClientError < Error; end
   class ServerError < Error; end
+
+  # Validation of Envato marketplaces.
+  class InvalidSiteName < Error; end
+  class InvalidSiteDomain < Error; end
 end

data/lib/envato/version.rb

@@ -1,6 +1,6 @@
 module Envato
   MAJOR = 0
-  MINOR = 0
-  PATCH = 5
+  MINOR = 1
+  PATCH = 0
   VERSION = [MAJOR, MINOR, PATCH].join '.'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envato-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Jacob Bednarz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-16 00:00:00.000000000 Z
+date: 2015-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,6 +145,7 @@ files:
 - lib/envato.rb
 - lib/envato/client.rb
 - lib/envato/client/stats.rb
+- lib/envato/client/user.rb
 - lib/envato/configurable.rb
 - lib/envato/connection.rb
 - lib/envato/errors.rb
@@ -174,3 +175,4 @@ signing_key:
 specification_version: 4
 summary: SDK for interacting with the Envato API.
 test_files: []
+has_rdoc: