berlin-buehnen-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b067e2c7a8005303d7f4f00698e86568aaa29ba0
+  data.tar.gz: b11c2b235ea91162366ad40fb91769489d0d3f88
+SHA512:
+  metadata.gz: 4490863eed8a8f8560a01439ee7def018bc49a995486fda85e275e546652f48a4d59cf7ffa131ce1861f8a4927b5696810c028ed2b78839b08bc5a345ca75199
+  data.tar.gz: aacbe36903e7d97554a952f89b9da3a8a411de5196304f5a6f10d4176b85ac539d3c79664ac81028a383cdd7b8750053f672de6ac1c9fcd3250b12363ae13cf3

data/README.md

@@ -0,0 +1,4 @@
+berlin-buehnen-client
+==================
+
+Simple client for the [Berlin Bühnen API](http://www.berlin-buehnen.de/media/docs/v1.html).

data/lib/berlin_buehnen/client.rb

@@ -0,0 +1,93 @@
+module BerlinBuehnen
+  class Client
+    include HTTMultiParty
+    USER_AGENT = "ASK HELMUT BerlinBuehnen API Wrapper #{VERSION}"
+    API_USERNAME_PARAM_NAME = "username"
+    API_KEY_PARAM_NAME = "api_key"
+    API_VERSION = "v1"
+    API_FORMAT = "json"
+    DEFAULT_OPTIONS = {
+      site: "www.berlin-buehnen.de",
+      language: "de"
+    }
+
+    attr_accessor :options
+    headers({"User-Agent" => USER_AGENT})
+
+    def initialize(options = {})
+      store_options(options)
+      raise ArgumentError, "An api key must be present" if api_key.nil?
+      raise ArgumentError, "An api username must be present" if api_username.nil?
+    end
+
+    def get(path, query={}, options={})
+      handle_response {
+        self.class.get(*construct_query_arguments(path, options.merge(:query => query)))
+      }
+    end
+
+    def head(path, query={}, options={})
+      handle_response {
+        self.class.head(*construct_query_arguments(path, options.merge(:query => query)))
+      }
+    end
+
+    # accessors for options
+    def api_username
+      @options[:username]
+    end
+
+    def api_key
+      @options[:api_key]
+    end
+
+    def site
+      @options[:site]
+    end
+    alias host site
+
+    def api_host
+      host
+    end
+
+    def api_language
+      @options[:language]
+    end
+
+    def api_url
+      [api_host, api_language, "api", API_VERSION].join("/")
+    end
+
+    private
+
+    def handle_response(&block)
+      response = block.call
+      return unless response
+
+      raise ResponseError.new(response) unless response.success?
+
+      BerlinBuehnen::Response.create(response)
+    end
+
+    def store_options(options={})
+      @options ||= DEFAULT_OPTIONS.dup
+      @options.merge!(options)
+    end
+
+    def construct_query_arguments(path_or_uri, options={}, body_or_query=:query)
+      uri = URI.parse(path_or_uri)
+      path = uri.path
+      scheme = "http"
+      options = options.dup
+      options[body_or_query] ||= {}
+      options[body_or_query][:format] = API_FORMAT
+      options[body_or_query][API_USERNAME_PARAM_NAME.to_sym] = api_username
+      options[body_or_query][API_KEY_PARAM_NAME.to_sym] = api_key
+
+      [
+        "#{scheme}://#{api_url}#{path}#{uri.query ? "?#{uri.query}" : ""}",
+        options
+      ]
+    end
+  end
+end

data/lib/berlin_buehnen/list_response.rb

@@ -0,0 +1,43 @@
+module BerlinBuehnen
+  class ListResponse < Response
+
+    META = "meta"
+    OBJECTS = "objects"
+
+    NEXT = "next"
+    PREVIOUS = "previous"
+    OFFSET = "offset"
+    LIMIT = "limit"
+    TOTAL_COUNT = "total_count"
+
+    def data
+      @data ||= @json_response[OBJECTS]
+    end
+
+    def next?
+      !meta[NEXT].nil?
+    end
+
+    def previous?
+      !meta[PREVIOUS].nil?
+    end
+
+    def limit
+      meta[LIMIT]
+    end
+
+    def offset
+      meta[OFFSET]
+    end
+
+    def total_count
+      meta[TOTAL_COUNT]
+    end
+
+    private
+    def meta
+      @meta ||= @json_response[META]
+    end
+
+  end
+end

data/lib/berlin_buehnen/response.rb

@@ -0,0 +1,20 @@
+module BerlinBuehnen
+  class Response
+    attr_reader :json_response
+
+    def self.create(response)
+      json_response = JSON.parse(response.body)
+
+      json_response.has_key?("meta") ? ListResponse.new(json_response) : new(json_response)
+    end
+
+    def initialize(json_response)
+      @json_response = json_response
+    end
+
+    def data
+      @data ||= @json_response
+    end
+
+  end
+end

data/lib/berlin_buehnen/response_error.rb

@@ -0,0 +1,20 @@
+module BerlinBuehnen
+  class ResponseError < HTTParty::ResponseError
+    STATUS_CODES = {
+      400 => "Bad Request",
+      403 => "Forbidden",
+      404 => "Not Found",
+      412 => "Precondition Failed",
+      500 => "Internal Server Error",
+      501 => "Not Implemented"
+    }
+
+    def message
+      error = response.parsed_response
+      "HTTP status: #{response.code} #{STATUS_CODES[response.code]} Error: #{error}"
+    rescue
+      "HTTP status: #{response.code} #{STATUS_CODES[response.code]}"
+    end
+
+  end
+end

data/lib/berlin_buehnen/version.rb

@@ -0,0 +1,3 @@
+module BerlinBuehnen
+  VERSION = '0.0.1'
+end

data/lib/berlin_buehnen.rb

@@ -0,0 +1,29 @@
+require "byebug"
+require 'hashie'
+require 'httmultiparty'
+require 'uri'
+
+require 'berlin_buehnen/client'
+require 'berlin_buehnen/response'
+require 'berlin_buehnen/list_response'
+require 'berlin_buehnen/version'
+
+module BerlinBuehnen
+
+  def new(options={})
+    Client.new(options)
+  end
+  module_function :new
+
+  def method_missing(method_name, *args, &block)
+    return super unless respond_to_missing?(method_name)
+    Client.send(method_name, *args, &block)
+  end
+  module_function :method_missing
+
+  def respond_to_missing?(method_name, include_private=false)
+    Client.respond_to?(method_name, include_private)
+  end
+  module_function :respond_to_missing?
+
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: berlin-buehnen-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Niels Hoffmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httmultiparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A wrapper for the BerlinBuehnen REST api. It provides simple methods
+  to retireve resources form the BerlinBuehnen REST api.
+email:
+- niels@askhelmut.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/berlin_buehnen.rb
+- lib/berlin_buehnen/client.rb
+- lib/berlin_buehnen/list_response.rb
+- lib/berlin_buehnen/response.rb
+- lib/berlin_buehnen/response_error.rb
+- lib/berlin_buehnen/version.rb
+homepage: https://askhelmut.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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A wrapper for the BerlinBuehnen REST api.
+test_files: []
+has_rdoc: