reddit-base 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cb71e8fcd16075836f4a9582b134c91825bdf96
+  data.tar.gz: 387602c1ada73880d1d8515045c75b55edc366e3
+SHA512:
+  metadata.gz: 1a252a3aa26a572e8a841a432d64f6b236f4c70de7b2707202b54ceb3d5133014388de6218d58e30b5462308ddfdb123bf16b5c35c8f90578f64342b4984a33a
+  data.tar.gz: 32b2579fcff87770557e8cf29ef21420db290a63f0601eaf91d5f15dba45ab2403e5458df4dfba54e006ed52d8a91d464638d55deea7985ff4795b2ac0b0799e

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.pryrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in reddit-base.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel O'Brien
+
+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,71 @@
+Reddit Base
+===========
+
+A minimal reddit API client for Ruby.
+
+Motivation
+----------
+
+Managing major versions of an API client can be tricky, especially when the
+API us unversioned, inconsistent and outside of your control.
+
+This client library aims to provide minimal support for the reddit API,
+reducing the need for frequent breaking changes and to act as the backbone
+for more other higher-level API clients.
+
+Installation
+------------
+
+Via Rubygems:
+
+    gem install reddit-base
+
+Or in your Gemfile with Bundler:
+
+    gem reddit-base
+
+Basic Usage
+-------------
+
+Retrieving a particular endpoint:
+
+    require 'reddit/base'
+
+    client = Reddit::Base::Client.new(user: USERNAME, password: PASSWORD)
+    client.get('/r/AskReddit')
+
+The above will return a `Faraday::Response` instance with JSON data in the
+`body` attribute.
+
+What it Does
+------------
+
+  * Authentication.
+  * Rate limiting.
+  * Modhash handling (reddit's CSRF protection).
+  * JSON coersion.
+  * Forwarding..
+  * Multipart POST.
+  * Reddit error wrapping.
+
+What it Doesn't
+---------------
+
+  * Parsing of Reddit "Things" and "Kinds."
+  * Parsing of common attributes like dates and times.
+  * HTML entity decoding (beware of "body" and "selftext").
+
+Recommended Reading
+-------------------
+
+  * reddit API documentation: http://www.reddit.com/dev/api
+  * reddit API wiki: https://github.com/reddit/reddit/wiki/API
+  * reddit project on Github: https://github.com/reddit/reddit
+
+Contributors
+------------
+
+  * Maintainer: [Daniel O'Brien](http://github.com/dobs)
+
+This project is copyright 2014 by its contributors, refer to LICENSE file for
+licensing information.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/reddit/base.rb

@@ -0,0 +1,14 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday_middleware/reddit'
+require 'json'
+
+require 'reddit/base/version'
+require 'reddit/base/basic_client'
+require 'reddit/base/client'
+require 'reddit/base/helpers'
+
+module Reddit
+  module Base
+  end
+end

data/lib/reddit/base/basic_client.rb

@@ -0,0 +1,34 @@
+module Reddit
+  module Base
+    # Basic client that doesn't make assumptions regarding response type.
+    #
+    # The reddit API isn't always consistent with its response types so may
+    # return HTML even when JSON is requested. Error pages are a common and
+    # unavoidable example.
+    class BasicClient
+      extend Forwardable
+
+      DEFAULT_OPTIONS = {
+        url: 'http://www.reddit.com',
+        headers: {'User-Agent' => "reddit-base, a reddit client for ruby by /u/dobs (v#{VERSION})"}
+      }.freeze
+
+      attr_reader :connection, :options
+
+      def_delegators :connection, :get, :post, :params, :headers
+
+      def initialize(options)
+        @options = DEFAULT_OPTIONS.merge(options)
+        @connection = Faraday.new(url: @options[:url], headers: @options[:headers]) do |builder|
+          builder.request :multipart
+          builder.request  :url_encoded
+          builder.request  :reddit_authentication, @options
+          builder.response :follow_redirects
+          builder.use  :reddit_rate_limit
+          builder.use  :reddit_modhash
+          builder.adapter  Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/reddit/base/client.rb

@@ -0,0 +1,26 @@
+module Reddit
+  module Base
+    # Client that does everything BasicClient does but also attempts to
+    # coerce and parse JSON.
+    class Client < BasicClient
+      def initialize(options)
+        super(options)
+
+        connection.builder.insert_before FaradayMiddleware::FollowRedirects, FaradayMiddleware::ParseJson
+        connection.builder.insert_before FaradayMiddleware::Reddit::RateLimit, FaradayMiddleware::Reddit::ForceJson
+      end
+
+      def get(*args, **options)
+        body = connection.get(*args, *options).body
+        body = Reddit::Base::Helpers.simplify body if options[:simplify]
+        body
+      end
+
+      def post(*args, **options)
+        body = connection.post(*args, *options).body
+        body = Reddit::Base::Helpers.simplify body if options[:simplify]
+        body
+      end
+    end
+  end
+end

data/lib/reddit/base/helpers.rb

@@ -0,0 +1,22 @@
+module Reddit
+  module Base
+    module Helpers
+      def self.simplify(json)
+        return json unless json.is_a? Hash
+
+        if json['data']
+          json['data']['kind'] = json['kind'] if json['data'].is_a? Hash
+          json = simplify json['data']
+        elsif json['children']
+          json['children'] = json['children'].map { |child| simplify child }
+        else
+          json.keys.each do |key|
+            json[key] = simplify json[key]
+          end
+        end
+
+        json
+      end
+    end
+  end
+end

data/lib/reddit/base/version.rb

@@ -0,0 +1,5 @@
+module Reddit
+  module Base
+    VERSION = '0.2.1'
+  end
+end

data/reddit-base.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reddit/base/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reddit-base"
+  spec.version       = Reddit::Base::VERSION
+  spec.authors       = ["Daniel O'Brien"]
+  spec.email         = ["dan@dobs.org"]
+  spec.summary       = %q{A minimal reddit API client for Ruby.}
+  spec.description   = %q{A minimal reddit API client for Ruby that
+    simplifies concerns such authentication, rate limiting and extracting
+    JSON.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'faraday_middleware-reddit', '0.2.1'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: reddit-base
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Daniel O'Brien
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: faraday_middleware-reddit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+description: |-
+  A minimal reddit API client for Ruby that
+      simplifies concerns such authentication, rate limiting and extracting
+      JSON.
+email:
+- dan@dobs.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/reddit/base.rb
+- lib/reddit/base/basic_client.rb
+- lib/reddit/base/client.rb
+- lib/reddit/base/helpers.rb
+- lib/reddit/base/version.rb
+- reddit-base.gemspec
+homepage: ''
+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.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A minimal reddit API client for Ruby.
+test_files: []