faraday_middleware-reddit 0.2.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.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,10 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov'
+end
+
+# Specify your gem's dependencies in faraday_middleware-reddit.gemspec
+gemspec
+

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,69 @@
+# FaradayMiddleware::Reddit
+
+A collection of Faraday middleware for use with the Reddit API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'faraday_middleware-reddit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday_middleware-reddit
+
+## Requirements
+
+`faraday` and `faraday_middleware` are currently gemspec dependencies.
+
+Like `faraday_middleware`, `faraday_middleware-reddit` requires a `json` library. Ruby versions prior to 1.9 will need to have one installed.
+
+## Usage
+
+`faraday_middleware-reddit` currently provides the following middleware:
+
+| Middleware | Type | Description |
+| --- | --- | --- |
+| `:reddit_authentication` | request | Authentication based on a username, password or pre-generated cookie. |
+| `:reddit_force_json` | request | Coerces reddit into returnign JSON for GET and POST requests. |
+| `:reddit_modhash` | use | Automatic modhash handling. |
+| `:reddit_rate_limit` | use | Rate limiting based on reddit's `x-ratelimit` headers. Accepts a `strategy` proc to override default linear strategy. |
+
+## Examples
+
+An example Farday client might look like:
+
+    require 'faraday_middleware/reddit'
+
+    conn = Faraday.new(:url => 'http://www.reddit.com', :headers => {'User-Agent' => 'faraday_middleware-reddit example (v 0.0.1)'}) do |faraday|
+      faraday.request  :url_encoded
+      faraday.request  :reddit_authentication, user: 'yourusername', password: 'yourpassword'
+
+      faraday.response :logger
+      faraday.response :follow_redirects
+
+      faraday.use  :reddit_force_json
+      faraday.use  :reddit_rate_limit
+      faraday.use  :reddit_modhash
+
+      faraday.adapter  Faraday.default_adapter
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Contributors
+------------
+
+  * Maintainer: [Daniel O'Brien](http://github.com/dobs)
+
+This project is copyright 2014 by its contributors, licensed under [Apache License 2.0](https://github.com/dobs/faraday_middleware-reddit/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+# RSpec tasks.
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/faraday_middleware-reddit.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday_middleware/reddit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday_middleware-reddit"
+  spec.version       = FaradayMiddleware::Reddit::VERSION
+  spec.authors       = ["Daniel O'Brien"]
+  spec.email         = ["dan@dobs.org"]
+  spec.description   = %q{A collection of Faraday middleware for use with the Reddit API.}
+  spec.summary       = %q{A collection of Faraday middleware for use with the Reddit API.}
+  spec.homepage      = ""
+  spec.licenses       = ['Apache 2.0']
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'faraday_middleware', '~> 0.9'
+end

data/lib/faraday_middleware/reddit.rb

@@ -0,0 +1,19 @@
+require 'faraday'
+
+module FaradayMiddleware
+  module Reddit
+    autoload :Authentication, 'faraday_middleware/reddit/request/authentication'
+    autoload :ForceJson,      'faraday_middleware/reddit/use/force_json'
+    autoload :Modhash,        'faraday_middleware/reddit/use/modhash'
+    autoload :RateLimit,      'faraday_middleware/reddit/use/rate_limit'
+
+    if Faraday::Middleware.respond_to? :register_middleware
+      Faraday::Request.register_middleware \
+        :reddit_authentication => lambda { Authentication }
+      Faraday::Middleware.register_middleware \
+        :reddit_force_json     => lambda { ForceJson },
+        :reddit_modhash        => lambda { Modhash },
+        :reddit_rate_limit     => lambda { RateLimit }
+    end
+  end
+end

data/lib/faraday_middleware/reddit/request/authentication.rb

@@ -0,0 +1,49 @@
+require 'faraday'
+
+module FaradayMiddleware::Reddit
+  # Request middleware that automatically handles user login.
+  #
+  # Requires that either a `user` and `password` are provided or a
+  # pre-generated `cookie`. Performs an additional login request when no
+  # valid login cookie is available.
+  class Authentication < Faraday::Middleware
+    AUTH_URL = 'https://ssl.reddit.com/post/login'.freeze
+
+    dependency do
+      require 'json' unless defined?(::JSON)
+    end
+
+    def initialize(app, options)
+      super(app)
+      @options = options
+      @user    = @options[:user]
+      @passwd  = @options[:password]
+      @rem     = @options[:remember]
+      @cookie  = @options[:cookie]
+
+      unless (@options[:user] && @options[:password]) || @options[:cookie]
+        raise ArgumentError, 'Either `user` and `password` or `cookie` need to be provided as options to the :reddit_authentication middleware'
+      end
+    end
+
+    def call(env)
+      authenticate(env) unless @cookie
+      set_cookie(env)
+      @app.call(env)
+    end
+
+    def authenticate(env)
+      response = Faraday.post AUTH_URL, {:user => @user, :passwd => @passwd, :rem => @rem, :api_type => 'json'}
+      @cookie = response.headers['set-cookie']
+    end
+
+    def set_cookie(env)
+      upstream_cookies = env[:request_headers]['Cookie']
+      env[:request_headers]['Cookie'] = if upstream_cookies
+        "#{upstream_cookies}; #{@cookie}"
+      else
+        @cookie
+      end
+    end
+  end
+end

data/lib/faraday_middleware/reddit/use/force_json.rb

@@ -0,0 +1,27 @@
+require 'faraday'
+
+module FaradayMiddleware
+  module Reddit
+    # Request middleware to force reddit to provide JSON responses when
+    # available.
+    #
+    # For GET requests that means adding `.json` to  the ends of URLs. For POST
+    # requests that means adding `api_type=json` to sent requests.
+    class ForceJson < Faraday::Middleware
+      def initialize(app, options = nil)
+        super(app)
+        @options = options || {}
+      end
+
+      def call(env)
+        if env[:method].to_s == 'get'
+          env[:url].path += '.json' unless env[:url].path.end_with?('.json')
+        elsif env[:method].to_s == 'post'
+          env[:body] = [env[:body], 'api_type=json'].compact.join('&')
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/faraday_middleware/reddit/use/modhash.rb

@@ -0,0 +1,41 @@
+require 'faraday'
+
+module FaradayMiddleware::Reddit
+  # Middleware that keeps track of and sets modhash-related HTTP headers.
+  #
+  # Reddit uses modhashes as a form of XSS protection and requires them for
+  # most POST and PUT requests. Modhashes are currently provided in response
+  # to listing GET requests.
+  class Modhash < Faraday::Middleware
+    dependency do
+      require 'json' unless defined?(::JSON)
+    end
+
+    def initialize(app, options = nil)
+      super(app)
+      @options = options || {}
+      @modhash = @options[:modhash]
+    end
+
+    def call(env)
+      @modhash = env[:modhash] if env[:modhash]
+      env[:request_headers]['X-Modhash'] = @modhash if @modhash
+      @app.call(env).on_complete do |env|
+        update_modhash(env)
+      end
+    end
+
+    def from_json(data)
+      if data.is_a?(String) && !data.strip.empty? && data.include?('modhash')
+        JSON.parse(data)
+      else
+        data
+      end
+    end
+
+    def update_modhash(env)
+      body = from_json(env[:body])
+      @modhash = body['data']['modhash'] if body['data']
+    end
+  end
+end

data/lib/faraday_middleware/reddit/use/rate_limit.rb

@@ -0,0 +1,47 @@
+require 'faraday'
+
+module FaradayMiddleware::Reddit
+  # Middleware for automatic rate limiting.
+  #
+  # Logs reddit's ratelimit HTTP headers and applies a caching strategy
+  # based on them. The default strategy is to block for x-ratelimit-reset /
+  # x-ratelimit_remaining.
+  class RateLimit < Faraday::Middleware
+    def initialize(app, options = nil)
+      super(app)
+      @options = options || {}
+      @strategy = @options[:strategy] || lambda { linear_strategy }
+
+      # Default rate limit settings.
+      @ratelimit_remaining = 30
+      @ratelimit_used      = 0
+      @ratelimit_reset     = 60
+      @ratelimit_cap       = 30
+    end
+
+    def call(env)
+      if @ratelimit_remaining <= 0 || env[:status] == 429
+        sleep(@ratelimit_reset)
+      else
+        @strategy.call
+      end
+
+      @app.call(env).on_complete do |env|
+        @ratelimit_remaining = env[:response_headers]['x-ratelimit-remaining'].to_i
+        @ratelimit_used      = env[:response_headers]['x-ratelimit-used'].to_i
+        @ratelimit_reset     = env[:response_headers]['x-ratelimit-reset'].to_i
+        @ratelimit_cap       = @ratelimit_remaining + @ratelimit_used
+      end
+    end
+
+    def linear_strategy
+      sleep (@ratelimit_reset.to_f / [1, @ratelimit_remaining].max)
+    end
+
+    def burst_strategy(threshold = 0.5)
+      if (@ratelimit_used / @ratelimit_cap.to_f) > threshold
+        linear_strategy
+      end
+    end
+  end
+end

data/lib/faraday_middleware/reddit/version.rb

@@ -0,0 +1,5 @@
+module FaradayMiddleware
+  module Reddit
+    VERSION = "0.2.1"
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,11 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rspec'
+require 'uri'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: faraday_middleware-reddit
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+  prerelease: 
+platform: ruby
+authors:
+- Daniel O'Brien
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A collection of Faraday middleware for use with the Reddit API.
+email:
+- dan@dobs.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- faraday_middleware-reddit.gemspec
+- lib/faraday_middleware/reddit.rb
+- lib/faraday_middleware/reddit/request/authentication.rb
+- lib/faraday_middleware/reddit/use/force_json.rb
+- lib/faraday_middleware/reddit/use/modhash.rb
+- lib/faraday_middleware/reddit/use/rate_limit.rb
+- lib/faraday_middleware/reddit/version.rb
+- spec/helper.rb
+homepage: ''
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A collection of Faraday middleware for use with the Reddit API.
+test_files:
+- spec/helper.rb
+has_rdoc: