stapeluberlauf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54382d58bda064e906f460acc85dcb69cd170a9e
+  data.tar.gz: 0536c70cda40779c6afad7d5c641ae31f0275513
+SHA512:
+  metadata.gz: 56b7cf3260c7f15a00800e3f620a0bb3c3b588cedb813f3659d27ebd5450b6fad8650688e4140dc1f8e04d62649ce9cef84ba128146013a882107fee4f225a96
+  data.tar.gz: 809ea489f06cc2edf5e5d05461d3977e6464877012e55458c39cdc77a4cbdb1da2c646e792f37b4495f95a3ac2971bc23f819fd82a9f50681c8aa385bf76c4fd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.2.3
+
+before_install:
+  - gem install bundler -v 1.10.6
+
+install:
+  - bundle install --without=documentation
+
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stapeluberlauf.gemspec
+gemspec
+
+group :test do
+  gem 'rspec', '~> 3.4.0'
+  gem 'vcr', '~> 3.0.1'
+  gem 'simplecov', require: false
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marius Rackwitz
+
+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,50 @@
+stapeluberlauf
+==============
+### /ˈʃtaːpl̩ ˈyːbɐˌlaʊ̯f/ _noun_, german word for stack overflow
+
+[![Build Status](http://img.shields.io/travis/mrackwitz/stapeluberlauf/master.svg?style=flat)](https://travis-ci.org/mrackwitz/stapeluberlauf)
+[![Gem Version](http://img.shields.io/gem/v/stapeluberlauf.svg?style=flat)](http://badge.fury.io/rb/stapeluberlauf)
+[![Code Climate](http://img.shields.io/codeclimate/github/mrackwitz/stapeluberlauf.svg?style=flat)](https://codeclimate.com/github/mrackwitz/stapeluberlauf)
+
+This gem provides a light-weight API wrapper to access the StackExchange API a little more conveniently.
+
+It consists mainly out of simple DSL, which allows to describe requests and abstracts the implementation of basic
+concepts like filters and paging.
+
+It supports authenticated requests and is aware when a request requires authorization, so that it can fail preemptive
+if this is not provided without a round-trip to the API.
+
+It does provide a simple model for the response wrapper. But this covers just a primitive mapping of the JSON attributes
+used for further communication negotiation. These include error indication, paging and rate limiting (quota).
+
+It doesn't provide wrappers for the retrieved model classes yet. These have to be accessed through the envelope as raw
+hashes.
+
+## Usage
+
+This example fetches the first 10 unanswered questions tagged as `ruby`.
+
+```ruby
+stackoverflow = Stapeluberlauf.site('stackoverflow').use_filter('withbody')
+questions = stackoverflow.questions(tagged: 'ruby').unanswered.execute
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stapeluberlauf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stapeluberlauf
+
+## Disclaimer
+
+This is not an official gem by StackExchange / StackOverflow.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stackexchange"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/last_unanswered_questions

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'stapeluberlauf'
+
+if ARGV.count != 1
+  puts "Usage: #{File.basename($0)} tagged"
+  exit 1
+end
+tagged = ARGV.shift
+
+stackoverflow = Stapeluberlauf.site('stackoverflow').use_filter('withbody')
+questions = stackoverflow.questions(tagged: tagged).unanswered
+questions.page_size = 10
+
+result = questions.execute
+result.items.each do |question|
+  puts "❓  #{question['title']}"
+  puts "🔗  #{question['link']}"
+  puts question['body']
+  puts "-- @#{question['owner']['display_name']}"
+  comments = stackoverflow.question(question['question_id']).comments.execute.items
+  next if comments.nil?
+  puts '-' * 10
+  comments.each do |comment|
+    puts "  #{comment['body']}"
+    puts "  -- @#{comment['owner']['display_name']}"
+  end
+  puts '*' * 80
+end

data/lib/stapeluberlauf/authorizable.rb

@@ -0,0 +1,39 @@
+module Stapeluberlauf
+  module Authorizable
+    # @return [String]
+    #   The secret key of the OAuth app which allows to authorize to increased throttle
+    #   quota and privileged access to user data.
+    #   Must be set in combination with an #acess_token.
+    #   If you don't have a request key you can obtain one by [registering your
+    #   application on Stack Apps](http://stackapps.com/apps/oauth/register).
+    attr_accessor :key
+
+    # @return [String]
+    #   The OAuth access token which allows to authorize to increased throttle
+    #   quota and privileged access to user data.
+    #   Must be set in combination with a #key.
+    #          
+    attr_accessor :access_token
+    
+    # Authorize a request with an access token and key.
+    #
+    # @param [String] key  @see #key
+    #
+    # @param [String] access_token  @see #access_token
+    #
+    # @return [Self] returns the receiver to support a floating API
+    #
+    def authorize(key, access_token)
+      self.key = key
+      self.access_token = access_token
+      return self
+    end
+    
+    # Returns whether all credentials are sufficiently set
+    # to execute authorized requests.
+    #
+    def authorized?
+      !key.nil? && !access_token.nil?
+    end
+  end
+end

data/lib/stapeluberlauf/error.rb

@@ -0,0 +1,35 @@
+module Stapeluberlauf
+  class Error < StandardError
+    # @return [Request] the request which resulted in the error
+    attr_accessor :request
+
+    # @return [Response] the erroneous response
+    attr_accessor :response
+
+    # Initialize a new error from a request and its response
+    #
+    # @param [Request] request  @see #request
+    #
+    # @param [Response] response  @see #response
+    #
+    def initialize(request, response)
+      super(response.error_message)
+      self.request = request
+      self.response = response
+    end
+
+    # Refers to an error type returned by the API
+    #
+    # @return [Int]
+    def id
+      response.error_id
+    end
+
+    # Returns the name of the error
+    #
+    # @return [String]
+    def name
+      response.error_name
+    end
+  end
+end

data/lib/stapeluberlauf/request/answer.rb

@@ -0,0 +1,20 @@
+module Stapeluberlauf
+  class Request
+    class Answer < Request
+      include Behavior::Acceptable
+      include Behavior::Commentable
+      include Behavior::Editable
+      include Behavior::Flagable
+      include Behavior::Upvotable
+      include Behavior::Downvotable
+
+      # Gets all questions the identified answers are on.
+      #
+      # @return [Request]
+      #
+      def questions
+        request('questions')
+      end
+    end
+  end
+end

data/lib/stapeluberlauf/request/behavior.rb

@@ -0,0 +1,13 @@
+module Stapeluberlauf
+  class Request
+    module Behavior
+      autoload :Acceptable,  'stapeluberlauf/request/behaviors/acceptable.rb'
+      autoload :Commentable, 'stapeluberlauf/request/behaviors/commentable.rb'
+      autoload :Downvotable, 'stapeluberlauf/request/behaviors/downvotable.rb'
+      autoload :Editable,    'stapeluberlauf/request/behaviors/editable.rb'
+      autoload :Favoritable, 'stapeluberlauf/request/behaviors/favoritable.rb'
+      autoload :Flagable,    'stapeluberlauf/request/behaviors/flagable.rb'
+      autoload :Upvotable,   'stapeluberlauf/request/behaviors/upvotable.rb'
+    end
+  end
+end

data/lib/stapeluberlauf/request/behaviors/acceptable.rb

@@ -0,0 +1,27 @@
+module Stapeluberlauf
+  class Request
+    module Behavior
+      module Acceptable
+        # Casts an accept vote.
+        #
+        # @note auth required
+        #
+        # @return [Request]
+        #
+        def accept
+          request('accept').auth_required!
+        end
+        
+        # Undoes an accept vote.
+        #
+        # @note auth required
+        #
+        # @return [Request]
+        #
+        def undo_accept
+          request('accept/undo').auth_required!
+        end
+      end
+    end
+  end
+end

data/lib/stapeluberlauf/request/behaviors/commentable.rb

@@ -0,0 +1,15 @@
+module Stapeluberlauf
+  class Request
+    module Behavior
+      module Commentable
+        # Get the comments.
+        #
+        # @return [Request]
+        #
+        def comments
+          request('comments')
+        end
+      end
+    end
+  end
+end

data/lib/stapeluberlauf/request/behaviors/downvotable.rb

@@ -0,0 +1,27 @@
+module Stapeluberlauf
+  class Request
+    module Behavior
+      module Downvotable
+        # Casts a downvote on the given resource.
+        #
+        # @note auth required
+        #
+        # @return [Request]
+        #
+        def downvote
+          request('downvote').auth_required!
+        end
+
+        # Undoes a downvote on the given resource
+        #
+        # @note auth required
+        #
+        # @return [Request]
+        #
+        def undo_downvote
+          request('downvote/undo').auth_required!
+        end
+      end
+    end
+  end
+end

data/lib/stapeluberlauf/request/behaviors/editable.rb

@@ -0,0 +1,27 @@
+module Stapeluberlauf
+  class Request
+    module Behavior
+      module Editable
+        # Edits the given resource.
+        #
+        # @note auth required
+        #
+        # @return [Request]
+        #
+        def edit
+          request('edit').auth_required!
+        end
+        
+        # Deletes the given resource.
+        #
+        # @note auth required
+        #
+        # @return [Request]
+        #
+        def delete
+          request('delete').auth_required!
+        end
+      end
+    end
+  end
+end

data/lib/stapeluberlauf/request/behaviors/favoritable.rb

@@ -0,0 +1,27 @@
+module Stapeluberlauf
+  class Request
+    module Behavior
+      module Favoritable
+        # Favorites the given resource.
+        #
+        # @note auth required
+        #
+        # @return [Request]
+        #
+        def favorite
+          request('favorite').auth_required!
+        end
+
+        # Undoes favoriting the given resouce.
+        #
+        # @note auth required
+        #
+        # @return [Request]
+        #
+        def undo_favorite
+          request('favorite/undo').auth_required!
+        end
+      end
+    end
+  end
+end

data/lib/stapeluberlauf/request/behaviors/flagable.rb

@@ -0,0 +1,27 @@
+module Stapeluberlauf
+  class Request
+    module Behavior
+      module Flagable
+        # Casts a flag on the given resource.
+        #
+        # @note auth required
+        #
+        # @return [Request]
+        #
+        def add_flag
+          request('flags/add').auth_required!
+        end
+        
+        # Returns valid flag options for the given resource.
+        #
+        # @note auth required
+        #
+        # @return [Request]
+        #
+        def flag_options
+          request('flags/options').auth_required!
+        end
+      end
+    end
+  end
+end

data/lib/stapeluberlauf/request/behaviors/upvotable.rb

@@ -0,0 +1,27 @@
+module Stapeluberlauf
+  class Request
+    module Behavior
+      module Upvotable
+        # Casts an upvote on the given resource.
+        #
+        # @note auth required
+        #
+        # @return [Request]
+        #
+        def upvote
+          request('upvote').auth_required!
+        end
+
+        # Undoes an upvote on the given resource
+        #
+        # @note auth required
+        #
+        # @return [Request]
+        #
+        def undo_upvote
+          request('upvote/undo').auth_required!
+        end
+      end
+    end
+  end
+end

data/lib/stapeluberlauf/request/comment.rb

@@ -0,0 +1,9 @@
+module Stapeluberlauf
+  class Request
+    class Comment < Request
+      include Behavior::Editable
+      include Behavior::Flagable
+      include Behavior::Upvotable
+    end
+  end
+end

data/lib/stapeluberlauf/request/question.rb

@@ -0,0 +1,124 @@
+module Stapeluberlauf
+  class Request
+    class Question < Site
+      include Behavior::Commentable
+      include Behavior::Editable
+      include Behavior::Favoritable
+      include Behavior::Flagable
+      include Behavior::Upvotable
+      include Behavior::Downvotable
+
+      # Renders a hypothetical question.
+      #
+      # @note auth required
+      #
+      # @return [Request]
+      #
+      def render
+        request('render').auth_required!
+      end
+
+      # Creates a new question.
+      #
+      # @note auth required
+      #
+      # @return [Request]
+      #
+      def add
+        request('add').auth_required!
+      end
+
+      # Get the answers to the questions
+      #
+      # @return [Request]
+      #
+      def answers
+        request('answers')
+      end
+
+      # Creates an answer on the given question. auth required
+      #
+      # @return [Request]
+      #
+      def add_answer
+        request('answers/add')
+      end
+
+      # Renders a hypothetical answer to a question.
+      #
+      # @return [Request]
+      #
+      def render_answer
+        request('answers/render')
+      end
+
+      # Returns valid flag options which are also close reasons for the given question.
+      #
+      # @note auth required
+      #
+      # @return [Request]
+      #
+      def close_options
+        request('close/options').auth_required!
+      end
+
+      # Get the questions that link to the questions.
+      #
+      # @return [Request]
+      #
+      def linked
+        request('linked')
+      end
+
+      # Get the questions that are related to the questions.
+      #
+      # @return [Request]
+      #
+      def related
+        request('related')
+      end
+
+      # Get the timelines of the questions.
+      #
+      # @return [Request]
+      #
+      def timeline
+        request('timeline')
+      end
+
+      # Get all questions on the site with active bounties.
+      #
+      # @return [Request]
+      #
+      def featured
+        request('featured')
+      end
+
+      # Get all questions on the site with *no* answers.
+      #
+      # @return [Request]
+      #
+      def no_answers
+        request('no-answers')
+      end
+
+      # Get all questions the site considers unanswered.
+      #
+      # @return [Request]
+      #
+      def unanswered
+        request('unanswered')
+      end
+
+      # Get questions the site considers unanswered within a user's favorite or interesting tags.
+      #
+      # @note auth required
+      #
+      # @return [Request]
+      #
+      def unanswered_with_my_tags
+        request('unanswered/my-tags').auth_required!
+      end
+    end
+  end
+end

data/lib/stapeluberlauf/request/site.rb

@@ -0,0 +1,45 @@
+require 'stapeluberlauf/authorizable.rb'
+require 'stapeluberlauf/request.rb'
+
+module Stapeluberlauf
+  class Request
+    class Site < Request
+      # Gets questions on the site.
+      #
+      # @param [String|Array] ids  one or multiple ids
+      #
+      # @param [Hash] params  the parameter
+      #
+      # @option params [String] tagged  one or multiple tags
+      #
+      # @return [Request]
+      #
+      def questions(ids=nil, **params)
+        resource_request(Question, ids, 'questions', params)
+      end
+      alias_method :question, :questions
+
+      # Gets answers on the site.
+      #
+      # @param [String|Array] ids  one or multiple ids
+      #
+      # @return [Request]
+      #
+      def answers(ids=nil, **params)
+        resource_request(Answer, ids, 'answers', params)
+      end
+      alias_method :answer, :answers
+
+      # Gets comments on the site.
+      #
+      # @param [String|Array] ids  one or multiple ids
+      #
+      # @return [Request]
+      #
+      def comments(ids=nil, **params)
+        resource_request(Comment, ids, 'comments', params)
+      end
+      alias_method :comment, :comments
+    end
+  end
+end

data/lib/stapeluberlauf/request.rb

@@ -0,0 +1,300 @@
+require 'json'
+require 'date'
+
+require 'stapeluberlauf/authorizable.rb'
+
+module Stapeluberlauf
+  class Request
+    autoload :Answer,   'stapeluberlauf/request/answer'
+    autoload :Behavior, 'stapeluberlauf/request/behavior'
+    autoload :Comment,  'stapeluberlauf/request/comment'
+    autoload :Question, 'stapeluberlauf/request/question'
+    autoload :Site,     'stapeluberlauf/request/site'
+
+    include Stapeluberlauf::Authorizable
+    
+    # @return [Int] the maxium number of items on a page
+    MAX_PAGE_SIZE = 100.freeze
+    
+    # @return [Net::HTTP] a HTTP client
+    attr_accessor :client
+
+    # @return [String] the path of the endpoint
+    attr_accessor :endpoint
+
+    # @return [Hash<Symbol, String>] the parameter
+    attr_accessor :params
+
+    # @return [Site] the site
+    attr_accessor :site
+
+    # @return [Int] the specific page to fetch, starts at and defaults to 1
+    attr_accessor :page
+
+    # @return [Int] any value between 0 and 100, defaults to 30 on API-site,
+    #               initialized by default to 100
+    attr_accessor :page_size
+
+    # Initialize a new instance
+    #
+    # @param [Net::HTTP] client  @see #client
+    #
+    # @param [Site] site  @see #site
+    #
+    # @param [String] endpoint  @see #endpoint
+    #
+    # @param [Hash<Symbol, String>] params  @see #params
+    #
+    def initialize(client=nil, site=nil, endpoint='', params={})
+      @client = client
+      @site = site
+      @endpoint = endpoint
+      @params = params
+      @page = 1
+      @page_size = MAX_PAGE_SIZE
+    end
+    
+    # Create a new request based on another instance.
+    #
+    # @param [Request] request
+    #   takes over all values from the given request
+    #
+    def self.based_on(base_request)
+      new.tap do |instance|
+        base_request.instance_variables.each do |var|
+          value = base_request.instance_variable_get(var)
+          method_sym = "#{var.to_s[1..-1]}="
+          instance.send(method_sym, value.is_a?(Fixnum) ? value : value.dup)
+        end
+      end
+    end
+    
+    # Request for items filtered by their creation time.
+    #
+    # @param [#to_time] after
+    #   Define a lower limit for the range of `creation_date`.
+    #
+    # @param [#to_time] before
+    #   Define an upper limit for the range of `creation_date`.
+    #
+    # @return [Request] returns the receiver to support a floating API
+    #
+    def created(after: nil, before: nil)
+      @params.merge!({
+        fromdate: from != nil ? before.to_time.to_i : nil,
+        todate:   to   != nil ? after.to_time.to_i   : nil,
+      })
+      self
+    end
+    
+    # Request for sorted results by a sort criteria.
+    #
+    # Calling this method multiple times on the same request instance
+    # will not add a further level of sorting, but override the previous
+    # defined sort order.
+    #
+    # @param [Symbol] sort_by  the sort order
+    #   Valid for posts (questions, answers) and comments:
+    #   - :creation: creation_date
+    #   - :votes:    score
+    #
+    #   Valid for posts (questions, answers):
+    #   - :activity: last_activity_date
+    #
+    #   Valid for questions (without prefilter as e.g. featured, unanswered, etc.):
+    #   - :hot:      by the formula ordering the hot tab
+    #   - :week:     by the formula ordering the week tab
+    #   - :month:    by the formula ordering the month tab
+    #
+    #   Valid for badges:
+    #   - :rank:     by rank (default)
+    #   - :name:     by name
+    #   - :type:     by type
+    #
+    # @param [String, nil] min
+    #   Define a lower limit for the range of the sort criteria.
+    #
+    # @param [String, nil] max
+    #   Define an upper limit for the range of the sort criteria.
+    #
+    # @return [Request] returns the receiver to support a floating API
+    #
+    def sort_by(sort_by, min: nil, max: nil)
+      @params.merge!({
+        sort: sort_by.to_s,
+        min:  min,
+        max:  max,
+      })
+      self
+    end
+
+    # Select a filter, which enables certain includes and excludes so that the specific
+    # subset of data that is necessary for the application use are returned at once.
+    #
+    # @param [String] identifier
+    #   This might be either the id of a filter retrieved after creating it
+    #   or one of the pre-defined filters.
+    #   - `default` returns the documented default fields
+    #   - `withbody` returns the default plus the *.body fields
+    #   - `none` is empty
+    #   - `total` includes just .total
+    #
+    # @return [Request] returns the receiver to support a floating API
+    #
+    def use_filter(identifier)
+      @params.merge!({
+        filter: identifier
+      })
+      self
+    end
+
+    # Execute the request.
+    #
+    # @return [Result]
+    #
+    def execute
+      if is_auth_required? && !authorized?
+        raise "Request to #{self.endpoint} is not authorized, but authentication is required!"
+      end
+      http_res = client.get(absolute_uri)
+      json = JSON.parse(http_res.body)
+      res = Response.new
+      json.map do |key, value|
+        res.send("#{key}=", value)
+      end
+      unless res.error_name.nil?
+        raise Stapeluberlauf::Error.new(self, res)
+      end
+      res
+    end
+
+    # Allows to paginate
+    #
+    # @return [Enumerator]
+    #
+    def pages
+      Enumerator.new do |yielder|
+        response = self.execute
+        yielder << response
+        page_request = self.dup
+        while response.has_more
+          page_request.page += 1
+          response = page_request.execute
+          yielder << response
+        end
+      end
+    end
+
+    # Returns all items
+    #
+    # @return [Array<Hash>]
+    #
+    def all_items
+      pages.flat_map(&:items)
+    end
+    
+    # Checks whether authentication is required.
+    #
+    # @return [Bool]
+    #
+    def is_auth_required?
+      @auth_required
+    end
+
+    # Returns the composed request URI with encoded parameters
+    #
+    # @return [URI]
+    #
+    def absolute_uri
+      URI.join(BASE_URI, relative_uri)
+    end
+
+    # Returns the composed request URI with encoded parameters
+    #
+    # @return [URI]
+    #
+    def relative_uri
+      uri = URI(endpoint)
+      uri.query = URI.encode_www_form(merged_params)
+      uri
+    end
+
+    protected
+    
+    # Define that authentication is required for this endpoint. 
+    #
+    # @return [Result]
+    #
+    def auth_required!
+      @auth_required = true
+      self
+    end
+
+    # Create a new request based on the current instance.
+    #
+    # @param [String] endpoint  @see #endpoint
+    #
+    # @param [Hash<Symbol, String>] params  @see #params
+    #
+    # @return [Request]
+    #
+    def request(endpoint, params={})
+      Request.based_on(self).tap do |instance|
+        instance.endpoint += "/#{endpoint}"
+        instance.params.merge! params
+      end
+    end
+
+    # Create a new request for a collection based on the current instance.
+    #
+    # @param [Class] request_class  the class of the request, if {ids} is not nil
+    #
+    # @param [String|Array] ids  one or multiple ids
+    #
+    # @param [String] endpoint  @see #endpoint
+    #
+    # @param [Hash<Symbol, String>] params  @see #params
+    #
+    # @return [Request]
+    #
+    def resource_request(request_class, ids, endpoint, params={})
+      request_class ||= self.class
+      request_class.based_on(self).tap do |instance|
+        instance.endpoint += "/#{endpoint}"
+        instance.params.merge! params
+        unless ids.nil?
+          instance.endpoint += "/#{process_ids(ids)}"
+        end
+      end
+    end
+
+    # Serialize a list of ids if necessary
+    #
+    # @param [String|Array] ids  the ids of one or multiple resources
+    #
+    # @return [String]
+    #
+    def process_ids(ids)
+      if ids.is_a? Array
+        raise "Not more than 100 ids are allowed!" if ids.length > 100
+        ids.join(';')
+      else
+        ids
+      end
+    end
+
+    # Returns the merged parameter from different attributes
+    #
+    # @return [Hash<Symbol, String>]
+    #
+    def merged_params
+      params.merge({
+        site: site,
+        page: page != 1 ? page : nil,
+        pagesize: page_size != MAX_PAGE_SIZE ? page_size : nil,
+        key: key,
+        access_token: access_token,
+      }).reject { |_,v| v.nil? }
+    end
+  end
+end

data/lib/stapeluberlauf/response.rb

@@ -0,0 +1,44 @@
+module Stapeluberlauf
+  class Response
+    # @return [Int, nil] is only set when the API detects the request took an unusually long time to run.
+    # When it is set an application must wait that number of seconds before calling that method again.
+    attr_accessor :backoff
+
+    # @return [Int, nil] refers to an error type returned by the API
+    attr_accessor :error_id
+
+    # @return [String, nil] message of the error referred by #error_id
+    attr_accessor :error_message
+
+    # @return [String, nil] name of the error referred by #error_name
+    attr_accessor :error_name
+
+    # @return [Boolean] whether there are more pages
+    attr_accessor :has_more
+
+    # @return [Array] an array of the type found in #type
+    attr_accessor :items
+
+    # @return [Int, nil] the requested page
+    # @note Not included in the `default` filter
+    attr_accessor :page
+
+    # @return [Int, nil] the size of the requested page
+    # @note Not included in the `default` filter
+    attr_accessor :page_size
+
+    # @return [Int] the maximum allowed quota bound to the credentials, if the requested was authorized
+    attr_accessor :quota_max
+
+    # @return [Int] the remaining quota bound to the credentials, if the requested was authorized
+    attr_accessor :quota_remaining
+
+    # @return [Int, nil] the total number of items
+    # @note Not included in the `default` filter
+    attr_accessor :total
+
+    # @return [String] the name of the entities returned in #items
+    # @note Not included in the `default` filter
+    attr_accessor :type
+  end
+end

data/lib/stapeluberlauf/version.rb

@@ -0,0 +1,3 @@
+module Stapeluberlauf
+  VERSION = "0.1.0"
+end

data/lib/stapeluberlauf.rb

@@ -0,0 +1,33 @@
+require 'uri'
+require 'faraday'
+
+module Stapeluberlauf
+  require 'stapeluberlauf/version'
+  autoload :Error,    'stapeluberlauf/error'
+  autoload :Request,  'stapeluberlauf/request'
+  autoload :Response, 'stapeluberlauf/response'
+
+  BASE_URI = URI.parse('https://api.stackexchange.com/2.2').freeze
+
+  class << self
+    # @return [Net::HTTP|Faraday]
+    #
+    attr_accessor :default_client
+
+    def default_client
+      @default_client ||= Faraday.new(url: BASE_URI.dup) do |builder|
+        builder.adapter Faraday.default_adapter
+      end
+    end
+  end
+
+  # Get access to a specific site by its name
+  #
+  # @param [String] name  @see Site#name
+  #
+  # @return [Site]
+  #
+  def self.site(name)
+    Stapeluberlauf::Request::Site.new(default_client, name)
+  end
+end

data/stapeluberlauf.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stapeluberlauf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stapeluberlauf"
+  spec.version       = Stapeluberlauf::VERSION
+  spec.authors       = ["Marius Rackwitz"]
+  spec.email         = ["git@mariusrackwitz.de"]
+
+  spec.summary       = %q{API wrapper to access the StackExchange API conveniently.}
+  spec.homepage      = "https://github.com/mrackwitz/stapeluberlauf"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9.2"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: stapeluberlauf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marius Rackwitz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: 
+email:
+- git@mariusrackwitz.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/last_unanswered_questions
+- lib/stapeluberlauf.rb
+- lib/stapeluberlauf/authorizable.rb
+- lib/stapeluberlauf/error.rb
+- lib/stapeluberlauf/request.rb
+- lib/stapeluberlauf/request/answer.rb
+- lib/stapeluberlauf/request/behavior.rb
+- lib/stapeluberlauf/request/behaviors/acceptable.rb
+- lib/stapeluberlauf/request/behaviors/commentable.rb
+- lib/stapeluberlauf/request/behaviors/downvotable.rb
+- lib/stapeluberlauf/request/behaviors/editable.rb
+- lib/stapeluberlauf/request/behaviors/favoritable.rb
+- lib/stapeluberlauf/request/behaviors/flagable.rb
+- lib/stapeluberlauf/request/behaviors/upvotable.rb
+- lib/stapeluberlauf/request/comment.rb
+- lib/stapeluberlauf/request/question.rb
+- lib/stapeluberlauf/request/site.rb
+- lib/stapeluberlauf/response.rb
+- lib/stapeluberlauf/version.rb
+- stapeluberlauf.gemspec
+homepage: https://github.com/mrackwitz/stapeluberlauf
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: API wrapper to access the StackExchange API conveniently.
+test_files: []
+has_rdoc: