riksteatern 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb9b51d8ad03311a39f4f6579bc7cd042100bf57
+  data.tar.gz: 3408bc0c2b2d89276941641ee986f64341daa427
+SHA512:
+  metadata.gz: 9529b9c5a434b9818bd7606eb66365b8dbbb8647f584bfc1f165bd3a9cbf3ba4d847f6fb9b51b30113d42b204c3cf257f6d1ebc1e27a1483785b7321de20bd33
+  data.tar.gz: 417e6284e0af28f8d4208032eae59518a55513e2f5396fc826eea18b1d6ff7847efc374385d9d382a6d455ab1d0b91f495172f023bd45a3b60f8e1d52fd4b08d

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/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Peter Hellberg
+
+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,81 @@
+# Riksteatern
+
+A small Ruby client for the Riksteatern API.
+
+You can find out more about the API (In Swedish) on [http://data.riksteatern.se/](http://data.riksteatern.se/).
+
+[![Build Status](https://travis-ci.org/peterhellberg/riksteatern.png?branch=master)](https://travis-ci.org/peterhellberg/riksteatern)
+
+## Dependencies
+
+No runtime dependencies. Bundler, Rake and Minitest are required for development.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'riksteatern'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install riksteatern
+
+## Usage
+
+*You need to be authenticated to use the API.*
+
+**Access request: [http://data.riksteatern.se/ansokan/](http://data.riksteatern.se/ansokan/)**
+
+```ruby
+Riksteatern.account('<USERNAME>', '<PASSWORD>')
+```
+
+Now you are ready to start fetching data :)
+
+```ruby
+# Find an event by id
+e = Riksteatern::Event.find(992423)
+e.name #=> "En mans föreställning"
+
+# Number of events in Stockholms län
+Riksteatern::Event.all(regionName: 'Stockholms län').size #=> 46
+
+# Find a venue by id
+v = Riksteatern::Venue.find(2260101)
+
+## The region name of the location
+v.location.region #=> "Västernorrlands län"
+
+## Print the address of the venue
+puts v.address
+
+# Find a production by id
+p = Riksteatern::Production.find(42)
+
+## Get the number of pictures
+p.pictures.size #=> 4
+
+## Get the categories of the production
+p.categories #=> ["Barn/Skola", "Teater", "Mim", "Musikteater"]
+```
+
+You might also want to take a look at the `specs`
+
+## Suggestions for improving the API
+
+ * Correct the spelling of `accesibility` *sic*
+ * Change `category` to `categories` since it is a list
+ * Upper limit on how many results to return
+ * Pagination of results
+
+## 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

data/Rakefile

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+task :default => :spec
+
+Rake::TestTask.new(:spec) do |t|
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Console"
+task :console do
+  Bundler.with_clean_env do
+    exec 'pry -r./lib/riksteatern'
+  end
+end

data/lib/riksteatern.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'riksteatern/api'
+require 'riksteatern/config'
+require 'riksteatern/errors'
+require 'riksteatern/event'
+require 'riksteatern/http'
+require 'riksteatern/producer'
+require 'riksteatern/production'
+require 'riksteatern/venue'
+require 'riksteatern/version'
+
+module Riksteatern
+  class << self
+    def configure(&block)
+      yield(config)
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def api
+      @api ||= Api.new(config)
+    end
+
+    def account(username, password)
+      configure do |c|
+        c.username = username
+        c.password = password
+      end
+
+      self
+    end
+  end
+end

data/lib/riksteatern/api.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+require 'uri'
+require 'json'
+
+module Riksteatern
+  class Api
+    attr_accessor :config
+
+    def initialize(config)
+      @config = config
+
+      if @config.username.nil? || @config.password.nil?
+        raise UnauthorizedUser, "Blank username/password"
+      end
+    end
+
+    def locations(params = {})
+      get_array(:lokal, 'locations', params)
+    end
+
+    def productions(params = {})
+      get_array(:produktion, 'productions', params)
+    end
+
+    def repertoires(params = {})
+      get_array(:repertoar, 'repertoires', params)
+    end
+
+    def get_array(endpoint, field_name, params)
+      get_json(endpoint, params)[field_name] || []
+    end
+
+    def get(path, params = {})
+      http_get prepared_uri(path, params)
+    end
+
+    def get_json(endpoint, params = {})
+      load_json get("#{endpoint}.json", params) || "{}"
+    end
+
+    private
+
+    def http_get(uri)
+      uri.userinfo = URI.escape "#{@config.username}:#{@config.password}", '@'
+
+      @config.http_client.get(uri)
+    end
+
+    def load_json(doc)
+      @config.json_parser.call(doc)
+    end
+
+    def prepared_uri(endpoint, params = {})
+      endpoint_uri(endpoint).tap do |uri|
+        uri.query = URI.encode_www_form(params)
+      end
+    end
+
+    def endpoint_uri(endpoint)
+      URI.parse("#{@config.base_url}/#{endpoint}")
+    end
+  end
+end

data/lib/riksteatern/config.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Riksteatern
+  class Config
+    attr_accessor :base_url, :username, :password,
+                  :json_parser, :http_client, :debug
+
+    def initialize
+      @base_url    = 'https://riksteatern.se:8181/api'
+      @username    = nil
+      @password    = nil
+      @json_parser = ->(d) { JSON.parse(d) }
+      @http_client = Riksteatern::HTTP
+      @debug       = false
+
+      yield self if block_given?
+    end
+  end
+end

data/lib/riksteatern/errors.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+module Riksteatern
+  class UnauthorizedUser < StandardError
+  end
+end

data/lib/riksteatern/event.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+module Riksteatern
+  class Event
+    class << self
+      def find(id)
+        data = get_data(eventId: id)
+        new(data.first) if data.any?
+      end
+
+      def all(params = {})
+        get_data(params).map { |c| new(c) }
+      end
+
+      alias :query :all
+
+      def get_data(params = {})
+        Riksteatern.api.repertoires(params)
+      end
+    end
+
+    attr_reader :data, :api_url, :id, :arranger_id, :arranger_name,
+                :name, :meta_description, :information_link, :venue_api_url,
+                :venue_name, :region_name, :municipality_name, :date, :time,
+                :ticket_information, :ticket_information_scenpass,
+                :ticket_information_online, :scenpass_benefit,
+                :public_show, :co_producer, :cancelled
+
+    def initialize(data)
+      @data = data.tap do |d|
+        i = d['eventInformation'] || {}
+
+        @api_url       = d['eventUrl']
+        @id            = @api_url.to_s.split('/').last.to_i
+        @arranger_id   = d['arrangerId'].to_i
+        @arranger_name = d['arrangerName']
+
+        @name                        = i['eventName']
+        @meta_description            = i['eventMetaDescription']
+        @information_link            = i['informationLink']
+        @venue_api_url               = i['venueUrl']
+        @venue_name                  = i['venueName']
+        @region_name                 = i['regionName']
+        @municipality_name           = i['municipalityName']
+        @date                        = i['eventDate']
+        @time                        = i['eventTime']
+        @ticket_information          = i['ticketInformation']
+        @ticket_information_scenpass = i['ticketInformationScenpass']
+        @ticket_information_online   = i['ticketInformationOnline']
+        @scenpass_benefit            = i['scenpassBenefit']
+        @public_show                 = i['publicShow']
+        @co_producer                 = i['coProducer']
+        @cancelled                   = i['cancelledEvent']
+      end
+    end
+  end
+end

data/lib/riksteatern/http.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'net/http'
+
+module Riksteatern
+  class HTTP
+    class << self
+      def get(uri)
+        response = make_request(uri)
+
+        if response.code == '401'
+          raise UnauthorizedUser, "Wrong username/password"
+        elsif response.code == '200'
+          response.body
+        else
+          nil
+        end
+      end
+
+      private
+
+      def setup_http(uri, &block)
+        Net::HTTP.start(uri.host, uri.port, {
+          use_ssl: uri.scheme == 'https'
+        }) do |http|
+          http.read_timeout = 60
+          http.verify_mode  = OpenSSL::SSL::VERIFY_NONE
+
+          yield(http)
+        end
+      end
+
+      def make_request(uri)
+        setup_http(uri) do |http|
+          response = http.request(prepared_request(uri))
+
+          http.finish
+
+          response
+        end
+      end
+
+      def prepared_request(uri)
+        Net::HTTP::Get.new(uri.request_uri).tap do |r|
+          r.basic_auth URI.decode(uri.user), URI.decode(uri.password)
+        end
+      end
+    end
+  end
+end

data/lib/riksteatern/producer.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module Riksteatern
+  class Producer
+    attr_reader :id, :name, :main_contact_id, :homepage, :logotype
+
+    def initialize(data)
+      @id              = data['producerId']
+      @name            = data['producerName']
+      @main_contact_id = data['mainContactId']
+      @homepage        = data['producerHomepage']
+      @logotype        = data['producerLogotype']
+    end
+  end
+end

data/lib/riksteatern/production.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+module Riksteatern
+  class Production
+    class << self
+      def find(id)
+        data = get_data(productionId: id)
+        new(data.first) if data.any?
+      end
+
+      def all(params = {})
+        get_data(params).map { |c| new(c) }
+      end
+
+      alias :query :all
+
+      def get_data(params = {})
+        Riksteatern.api.productions(params)
+      end
+    end
+
+    attr_reader :data, :api_url, :id, :name, :intro_text, :description,
+                :homepage, :participants, :number_of_participants,
+                :performance_length_hours, :performance_length_minutes,
+                :pause, :categories, :pictures,
+                :first_performance_location, :first_performance_date,
+                :premiere_location, :premiere_date,
+                :new_premiere_location, :new_premiere_date,
+                :producer
+
+    def initialize(data)
+      @data = data.tap do |d|
+        i = d['productionInformation'] || {}
+
+        @api_url                    = d['productionUrl']
+        @id                         = Integer(@api_url.split('/').last)
+        @name                       = i['productionName']
+        @intro_text                 = i['productionIntroText']
+        @description                = i['productionDescription']
+        @homepage                   = i['productionHomepage']
+        @participants               = i['participants']
+        @number_of_participants     = i['numberOfParticipants']
+        @performance_length_hours   = i['performanceLengthHrs'].to_i
+        @performance_length_minutes = i['performanceLengthMns'].to_i
+        @pause                      = i['pause']
+        @categories                 = i['category']
+        @pictures                   = i['productionPictures']
+        @first_performance_location = i['firstPerformanceLocation']
+        @first_performance_date     = i['firstPerformanceDate']
+        @premiere_location          = i['premiereLocation']
+        @premiere_date              = i['premiereDate']
+        @new_premiere_location      = i['newPremiereLoction']
+        @new_premiere_date          = i['newPremiereDate']
+
+        @producer = Producer.new(d['producerInformation'])
+      end
+    end
+  end
+end