envato-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77469e8b80cdd6940d1b7f0e523d1b9617044c78
+  data.tar.gz: d2e0007d126080cd368df50482d473f479673a5b
+SHA512:
+  metadata.gz: 1b6f64a85d45505bd672d5c2fed943061b71523be5a471ba51f590de2da85c71fbc7e7bb7f909e25f961cf96e16f2100becb968155e529dd73459255e71e4884
+  data.tar.gz: 6d8ce3d3cd7466d1ef9b94ef6b640dec146523888ea1b7598c1d983ae605c4288d58fed75984b3bfee57b254e4861ee068f78858e233f49a879404ca976fba80

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jacob Bednarz
+
+MIT License
+
+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,112 @@
+# Envato Ruby SDK [![Build Status](https://travis-ci.org/jacobbednarz/envato-ruby-sdk.svg?branch=master)](https://travis-ci.org/jacobbednarz/envato-ruby-sdk)
+
+Interact with the [Envato API][envato_api_url] using Ruby.
+
+## Installation
+
+Quickstart
+
+```
+$ gem install envato-sdk
+```
+
+Or using a Gemfile:
+
+```
+$ gem 'envato-sdk'
+```
+
+## Usage
+
+First things first. Create an instance of the client which will be used by all
+connections from here on out.
+
+```rb
+client = Envato::Client.new(token: 'mytops3crettoken')
+
+# Send a 'GET' for the total number of users.
+response = client.get 'market/total-users.json'
+# => {"total-users"=>{"total_users"=>"5942654"}}
+```
+
+As this project grows the endpoints will be wrapped in usable methods so instead
+of building the request above, you can use the following:
+
+```rb
+client = Envato::Client.new(token: 'mytops3crettoken')
+client.total_users
+# => 8676143
+
+# Or maybe...
+user_count = Envato::Users.total
+```
+
+## Testing
+
+RSpec is the testing tool of choice and you can kick off the test suite by
+running:
+
+```
+$ bundle exec rspec spec
+```
+
+The following Ruby versions are supported (and [tested against][travis_ci_url]):
+
+- Ruby 2.0
+- Ruby 2.1
+- Ruby 2.2
+
+## Using VCR
+
+To ensure the test suite runs nice and fast we use VCR which generates our mocks
+but using a real request that is stored inside of `spec/cassettes`. The way it
+achieves this is it that each HTTP request is wrapped in a block which captures
+the request, filters sensitive data and then stores it for the next person to
+use. This means that not everyone needs to generate fresh requests and can
+leverage known working responses.
+
+As with all mocks, when the endpoint or functionality changes it is a good idea
+to re-do them to ensure you are still testing against live endpoints. To do that
+in this project, you'll need to run the following:
+
+```
+# Remove the existing files. You can be more specific here if you need to be.
+$ rm -rf spec/cassettes/*
+
+# Pass your REAL credentials in as environment variables and run the RSpec
+# command.
+$ ENVATO_TEST_API_TOKEN=thisisarealtoken \
+  ENVATO_TEST_API_TOKEN=thisisarealuser \
+  bundle exec rspec spec
+```
+
+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!)
+
+## Releasing a new version
+
+Everything you need to build a new release can be done by running:
+
+```
+$ script/release
+```
+
+This will handle pushing a new version of the gem to rubygems.org, a tag to
+GitHub and updating the `master` branch.
+
+## Contributing
+
+Contributions are welcome (in fact, encouraged!) to this project. To ensure
+everything continues humming along nicely, there are a few guidelines.
+
+- All code changes **must** add tests for the functionality. Without tests
+  someone may accidently break your changes and cause regressions.
+- If looking to add a large piece of new functionality,
+  [open an issue][new_issue_url] first and get some feedback on whether it's
+  something the maintainers are willing to accept. We don't want anyone wasting
+  time on changes only to be told the project won't accept them.
+
+[envato_api_url]: https://build.envato.com
+[travis_ci_url]: https://travis-ci.org/jacobbednarz/envato-ruby-sdk
+[new_issue_url]: https://github.com/jacobbednarz/envato-ruby-sdk/issues/new

data/lib/envato-sdk.rb

@@ -0,0 +1,2 @@
+# This is here so that we can have a different gem name to the class names.
+require 'envato'

data/lib/envato.rb

@@ -0,0 +1,3 @@
+require 'envato/client'
+require 'envato/errors'
+require 'envato/version'

data/lib/envato/client.rb

@@ -0,0 +1,80 @@
+require 'faraday'
+require 'json'
+
+module Envato
+  class Client
+    def initialize(options = {})
+      if options[:token].nil?
+        raise MissingAPITokenError, 'You must define an API token for authorization.'
+      end
+
+      @options = options
+    end
+
+    def inspect
+      inspected = super
+
+      if @options[:token]
+        inspected = inspected.gsub! @options[:token], conceal(@options[:token])
+      end
+
+      inspected
+    end
+
+    def get(url)
+      request :get, url
+    end
+
+    def conceal(string)
+      if string.length < 8
+        '****'
+      else
+        front = string[0, 4]
+        back  = string[-4, 4]
+        "#{front}****#{back}"
+      end
+    end
+
+    def proxy?
+      (ENV['HTTPS_PROXY'].nil? || ENV['HTTPS_PROXY'].empty?) ? false : true
+    end
+
+    def proxy_opts
+      (proxy?) ? { uri: ENV['HTTPS_PROXY'] } : nil
+    end
+
+    def ssl_opts
+      { verify: true }
+    end
+
+    def api_host
+      'https://api.envato.com'
+    end
+
+    def api_version
+      'v1'
+    end
+
+    private
+
+    def request(method, url, options = {})
+      request = Faraday.new(url: api_host, ssl: ssl_opts) do |c|
+        c.adapter Faraday.default_adapter
+        c.headers['User-Agent'] = "Envato SDK (#{Envato::VERSION})"
+        c.authorization(:Bearer, @options[:token])
+        c.proxy proxy_opts
+      end
+
+      case method
+      when :get
+        response = request.get "#{api_version}/#{url}"
+      end
+
+      begin
+        JSON.parse(response.body)
+      rescue JSON::ParserError
+        response.body
+      end
+    end
+  end
+end

data/lib/envato/errors.rb

@@ -0,0 +1,2 @@
+# User is missing the required API token.
+class MissingAPITokenError < ArgumentError; end

data/lib/envato/version.rb

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

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: envato-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jacob Bednarz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+description: SDK for interacting with the Envato API.
+email:
+- jacob.bednarz@envato.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/envato-sdk.rb
+- lib/envato.rb
+- lib/envato/client.rb
+- lib/envato/errors.rb
+- lib/envato/version.rb
+homepage: https://build.envato.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: SDK for interacting with the Envato API.
+test_files: []