scb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a73a1fdb7a6724a94a2721049039fbf08d737fd
+  data.tar.gz: 6272df8f28e9a96cf2211a15a2c2e8f361c828ce
+SHA512:
+  metadata.gz: c540e8ea2c2539410f591505121f47d086d5d8d952ac56e72d05c0d6f310dc6dddfbf97a81e4588a1ed510ed3875d2f74eac5ac997e91cc8e25eca2212a53278
+  data.tar.gz: ee308c40c529f41eb3e696214d148ea30c4fd3ba89eac01f3e7a5e0df32208ff8f7122311fd9ab9de14846e9ed972efcec36052580a3ed474405a1383b317bd4

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,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scb.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,131 @@
+# SCB
+
+A small API client for the SCB API.
+
+You probably want to read the [API\_beskrivning.pdf](http://www.scb.se/Grupp/OmSCB/Dokument/API_beskrivning.pdf) (in Swedish)
+
+[![Build Status](https://travis-ci.org/peterhellberg/scb.png?branch=master)](https://travis-ci.org/peterhellberg/scb)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'scb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scb
+
+## Usage
+
+It is probably a good idea to take a look in `specs`
+
+Configuration of the API client is done automatically, but it is also possible to manually compose the objects:
+
+```ruby
+# Manual composition
+config = SCB::API.config.new
+api    = SCB::API.new(config)
+db     = SCB::DB.new(api)
+table  = db.table('ProdbrEl')
+
+# Short form
+table = SCB.table('ProdbrEl')
+
+# Liquid renewable energy in 2009
+table.query Bransle: 925, Tid: 2009
+```
+
+### Configuration
+
+Nothing needs to be configured out of the box, but you can change the
+`api_host`, `api_name`, `api_version`, `language`, `database`, 
+`http_client` and `json_parser` settings like this:
+
+```ruby
+# English config
+config = SCB::API::Config.new do |c|
+  c.language = 'en'
+end
+
+# You can also pass a block straight to SCB.api
+SCB.api { |c| c.api_host = 'scb.test' } 
+```
+
+### Database
+
+The database is divided into levels/sub-levels and tables.
+
+The default language is 'sv' but there is also some data unde 'en'
+
+```ruby
+db = SCB.db
+
+# The names of All the top levels
+db.levels.map(&:name)
+
+# English levels under 
+db.level(BO0303')
+
+# The English title of LonArb07Privat
+SCB.db.en.table('LonArb07Privat').title
+```
+
+### Level
+
+The database levels can contain sub-levels or tables. You are probably
+more interested in the actual tables and their data. 
+
+```ruby
+# All the levels below BO
+SCB.level('BO').levels
+
+# All the tables below HE0110A
+SCB.level('HE0110A').tables
+```
+
+### Table
+
+This is probably where you want to spend most of your time.
+
+You can ask the table for possible variables in order to construct your query. I’ve implemented a simplified query format along the lines: `Key: value` where value is automatically turned into an Array if you only want a single value.
+
+*Note:* Each value is also turned into a string.
+
+```ruby
+# Database table containing data on electricity production
+table = SCB.table('EltillfM')
+
+# URI to the API endpoint for the table
+table.uri
+
+# The variable codes for the table
+table.variables.map(&:code)
+
+# Query: Wind production in January and February of 2013
+table.query Prodslag: "Vind", Tid: ["2013M01", "2013M02"]
+
+# Usage of the Internet
+table = SCB.table('LE0108T05')
+
+table.query Tid: 2012, Dem: "25-34"
+
+# You can also get the result as a png
+filename = '/tmp/internet_usage_2011.png'
+query    = { AnvOmr: 80, Tid: 2011, ContentsCode: "LE0108A2" }
+
+table.write_png_query(filename, query)
+```
+*Note:* `write_png_query` will not overwrite existing files.
+
+## 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,15 @@
+# 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
+  exec 'pry -r./lib/scb'
+end

data/lib/scb.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require "scb/api"
+require "scb/db"
+require "scb/http"
+require "scb/version"
+
+module SCB
+  class << self
+    def api(config = nil)
+      API.new(config).tap do |a|
+        yield(a.config) if block_given?
+      end
+    end
+
+    def db(api = nil)
+      @db ||= DB.new(api)
+    end
+
+    def level(name, text = nil, api = nil)
+      DB::Level.new(name, text, api = nil)
+    end
+
+    def table(name, api = nil)
+      DB::Table.new(name, api)
+    end
+  end
+end

data/lib/scb/api.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+require 'uri'
+
+require_relative "api/config"
+
+module SCB
+  class API
+    attr_accessor :config
+
+    def initialize(config = nil)
+      @config = config || API::Config.new
+
+      yield(@config) if block_given?
+    end
+
+    def get(path = nil)
+      response = http_get(path)
+
+      if response && response.body
+        response.body.force_encoding('UTF-8')
+      end
+    end
+
+    def get_and_parse(path = nil)
+      load_json get(path)
+    end
+
+    def post(path, query)
+      response = http_post path, dump_json(query)
+      response_body_without_utf8_bom(query, response)
+    end
+
+    def post_and_parse(path, query)
+      query.merge!({ response: { format: "json" }})
+      load_json post(path, query)
+    end
+
+    def base_url
+      config.base_url
+    end
+
+    def uri(endpoint = nil)
+      URI.parse("#{base_url}/#{endpoint}")
+    end
+
+    def load_json(doc)
+      config.json_parser.load(doc)
+    end
+
+    def dump_json(obj)
+      config.json_parser.dump(obj)
+    end
+
+    private
+
+    def response_body_without_utf8_bom(query, response)
+      if query[:response] && query[:response][:format] == "json"
+        # Force the response body to be UTF-8
+        body = response.body.force_encoding('UTF-8')
+
+        # Return the body, stripped of the BOM
+        body.sub!(/^\xEF\xBB\xBF/, '')
+      else
+        response.body
+      end
+    end
+
+    def http_get(path)
+      config.http_client.get(uri(path))
+    end
+
+    def http_post(path, payload)
+      config.http_client.post(uri(path), payload)
+    end
+  end
+end

data/lib/scb/api/config.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'json'
+
+module SCB
+  class API
+    class Config
+      attr_accessor :api_host, :api_name, :api_version,
+                    :language, :database, :http_client, :json_parser
+
+      def initialize
+        @api_host    = 'api.scb.se'
+        @api_name    = 'OV0104'
+        @api_version = 'v1/doris'
+        @language    = 'sv'
+        @database    = 'ssd'
+        @http_client = SCB::HTTP
+        @json_parser = JSON
+
+        yield self if block_given?
+      end
+
+      def base_url
+        "http://#{api_host}/#{api_name}/#{api_version}/#{language}/#{database}"
+      end
+
+      def self.language(language)
+        new { |c| c.language = language }
+      end
+    end
+  end
+end

data/lib/scb/db.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require_relative "db/level"
+require_relative "db/table"
+require_relative "db/variable"
+
+module SCB
+  class DB
+    attr_accessor :api
+
+    def initialize(api = nil)
+      @api = api || SCB.api
+    end
+
+    def levels(klass = Level)
+      @levels ||= data.map do |l|
+        klass.new(l["id"], l["text"], api)
+      end
+    end
+
+    def level(name, text = nil, klass = Level)
+      klass.new(name, text, api)
+    end
+
+    def table(name, klass = Table)
+      klass.new(name, api)
+    end
+
+    def uri
+      api.uri
+    end
+
+    def en
+      language('en')
+    end
+
+    def sv
+      language('sv')
+    end
+
+    private
+
+    def data
+      api.get_and_parse
+    end
+
+    def language(language_code)
+      api.config.language = language_code
+      self
+    end
+
+    class InvalidQuery < RuntimeError
+    end
+  end
+end

data/lib/scb/db/level.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require_relative '../db'
+
+module SCB
+  class DB
+    class Level
+      attr_reader :name, :text, :api
+
+      def initialize(name, text = nil, api = nil)
+        @name = name
+        @text = text
+        @api  = api || SCB.api
+      end
+
+      def levels(klass = Level)
+        @levels ||= objects_for_type(klass, "l")
+      end
+
+      def tables(klass = Table)
+        @tables ||= objects_for_type(klass, "t")
+      end
+
+      def inspect
+        name
+      end
+
+      private
+
+      def objects_for_type(klass, type)
+        data.map { |d|
+          klass.new(d["id"], api) if d["type"] == type
+        }.compact
+      end
+
+      def data
+        @data ||= api.get_and_parse(name) || []
+      end
+    end
+  end
+end