filmtipset 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6699b96e8571bdf6a02935108ed69f4aae57598
+  data.tar.gz: 00a00c0f9315c1f1a0381684bc72a3d1fdef90a0
+SHA512:
+  metadata.gz: b2784da212f38a7032aff8775b7b7713d0772fa8dce476464bd82e6ed3889b65800d68a9a1c78e7cbb175c69811142ccf1073bdf55f831d9e4e487f70a36ba77
+  data.tar.gz: 976b76d508aaa40a2703c66d70f2b3092de39c73dd57c6826da907d70b2f70439915a1eb932f57698bdc908938dca0038732dd808325a3d85fc633e9b64e9577

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.env
+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 filmtipset.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,50 @@
+# Filmtipset
+
+API client for the Filmtipset API (requires access key)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'filmtipset'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install filmtipset
+
+## Setup
+
+```ruby
+Filmtipset.access_key = 'your_access_key'
+```
+
+## Usage
+
+```ruby
+# Get 'The Matrix' by id
+Filmtipset.movie id: 143
+
+# Get 'Brad Pitt' by id
+Filmtipset.person id: 123
+
+# Get 'Pulp Fiction' by IMDB id
+Filmtipset.imdb id: '0110912'
+
+# Get a list the movies you’ve seen
+Filmtipset.list userkey: <YOUR_USER_KEY>, id: 'seen'
+
+# Get recommendations for 'Kortfilm'
+Filmtipset.recommendations userkey: <YOUR_USER_KEY>, id: 2
+```
+
+## 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,18 @@
+# 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
+    code = 'Filmtipset.access_key = FILMTIPSET_ACCESS_KEY if eval(`cat .env`)'
+    exec "pry -r./lib/filmtipset -e '#{code}'"
+  end
+end

data/filmtipset.gemspec

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "filmtipset/version"
+
+Gem::Specification.new do |gem|
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.name          = "filmtipset"
+  gem.version       = Filmtipset::VERSION
+  gem.authors       = ["Peter Hellberg"]
+  gem.email         = ["peter@c7.se"]
+  gem.summary       = "API client for the Filmtipset API (requires access key)"
+  gem.homepage      = "https://github.com/peterhellberg/skatteverket"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler",  "~> 1.3"
+  gem.add_development_dependency "rake",     "~> 10.0"
+  gem.add_development_dependency "minitest", "~> 5.0"
+
+  gem.post_install_message = "\nYou need an access key in order to " +
+                             "use this gem.\n\n    Required setup: " +
+                             "Filmtipset.access_key = 'your_access_key'\n\n"
+end

data/lib/filmtipset.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require "forwardable"
+
+require "filmtipset/api"
+require "filmtipset/version"
+
+module Filmtipset
+  class << self
+    extend Forwardable
+
+    def api
+      @api ||= Api.new
+    end
+
+    def_delegators :api, :access_key=, :movie, :person, :comment,
+                   :imdb, :list, :add_to_list, :recommendations,
+                   :user, :user_latest, :user_messages, :message,
+                   :mark_message_unread, :send_message, :grade, :search
+  end
+end

data/lib/filmtipset/api.rb

@@ -0,0 +1,153 @@
+# encoding: utf-8
+
+require "uri"
+require "open-uri"
+require "json"
+
+require_relative "api/genre"
+
+module Filmtipset
+  class Api
+    attr_accessor :access_key
+
+    def movie(params = {})
+      action 'movie', params, :id
+    end
+
+    def person(params = {})
+      action 'person', params, :id
+    end
+
+    def comment(params = {})
+      action 'comment', params, :userkey, :id, :comment
+    end
+
+    def imdb(params = {})
+      action 'imdb', params, :id
+    end
+
+    def list(params = {})
+      action 'list', params
+    end
+
+    def add_to_list(params = {})
+      action 'add-to-list', params, :userkey, :id, :movie
+    end
+
+    def recommendations(params = {})
+      verify_genre_id(params[:id])
+
+      action 'recommendations', params, :userkey, :id
+    end
+
+    def user(params = {})
+      action 'user', params, :id
+    end
+
+    def user_latest(params = {})
+      action 'user-latest', params, :id
+    end
+
+    def user_messages(params = {})
+      action 'user-messages', params, :userkey
+    end
+
+    def message(params = {})
+      action 'message', params, :id
+    end
+
+    def mark_message_unread(params = {})
+      action 'mark-message-unread', params, :id
+    end
+
+    def send_message(params = {})
+      action 'send-message', params, :userkey, :recipient, :subject, :body
+    end
+
+    def grade(params = {})
+      verify_grade params[:grade]
+
+      action 'grade', params, :userkey, :id, :grade
+    end
+
+    def search(params = {})
+      action 'search', params, :id
+    end
+
+    private
+
+    def action(name, params, *required)
+      access_key_is_required
+      verify_required(params, required)
+
+      get params.merge(action: name)
+    end
+
+    def get(params = {})
+      fetch prepared_uri(params)
+    end
+
+    def fetch(uri)
+      parse open(uri).read
+    rescue OpenURI::HTTPError => e
+      raise HTTPError, uri
+    end
+
+    def parse(json)
+      JSON.parse(json)
+    rescue JSON::ParserError => e
+      raise JSONError, e
+    end
+
+    def prepared_uri(params = {})
+      base_uri.tap do |uri|
+        uri.query = query_params(params)
+      end
+    end
+
+    def query_params(params)
+      URI.encode_www_form handle_params(params)
+    end
+
+    def handle_params(params)
+      {
+        accesskey: access_key,
+        returntype: 'json'
+      }.merge(params)
+    end
+
+    def base_uri
+      URI.parse('http://www.filmtipset.se/api/api.cgi')
+    end
+
+    def access_key_is_required
+      if access_key.nil? || access_key.empty?
+        raise NoAccessKeyError, "You need to provide an access key!"
+      end
+    end
+
+    def verify_genre_id(id)
+      Genre.verify_id(id)
+    end
+
+    def verify_grade(rating)
+      unless (1..5).include?(rating.to_i)
+        raise InvalidGrade, "The grade must be in the range 1-5"
+      end
+    end
+
+    def verify_required(params, keys)
+      keys.each do |key|
+        if params[key].to_s.empty?
+          raise MissingParameter, "The params must include :#{key}"
+        end
+      end
+    end
+
+    class HTTPError        < StandardError; end
+    class JSONError        < StandardError; end
+    class NoAccessKeyError < StandardError; end
+    class InvalidGrade     < StandardError; end
+    class MissingParameter < StandardError; end
+  end
+end

data/lib/filmtipset/api/genre.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+module Filmtipset
+  class Api
+    class Genre
+      class << self
+        def valid_id?(id)
+          TABLE.has_key?(id.to_s)
+        end
+
+        def verify_id(id)
+          unless valid_id?(id)
+            raise InvalidId, "The genre id '#{id}' is not valid!"
+          end
+        end
+      end
+
+      TABLE = {
+        "0"  => "Generella tips",
+        "1"  => "Drama",
+        "2"  => "Kortfilm",
+        "3"  => "Komedi",
+        "4"  => "Dokumentär",
+        "5"  => "Animerad",
+        "6"  => "Vuxenfilm",
+        "7"  => "Familjefilm",
+        "8"  => "Action",
+        "9"  => "Kriminalare",
+        "10" => "Romantik",
+        "11" => "Thriller",
+        "12" => "Musikal",
+        "13" => "Äventyr",
+        "14" => "Western",
+        "15" => "Skräck",
+        "16" => "Science Fiction",
+        "17" => "Fantasy",
+        "18" => "Mysterium",
+        "19" => "Krig",
+        "20" => "Film-Noir",
+        "21" => "Scenshow",
+        "22" => "Anime",
+        "23" => "Mini-serie",
+        "24" => "Stumfilm",
+        "25" => "Amatörfilm",
+        "38" => "Experimentfilm",
+        "39" => "Roadmovie",
+        "40" => "Biografi"
+      }
+
+      class InvalidId < StandardError; end
+    end
+  end
+end

data/lib/filmtipset/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Filmtipset
+  VERSION = "0.0.1"
+end

data/spec/filmtipset_spec.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require_relative 'spec_helper'
+
+describe Filmtipset do
+  subject { Filmtipset }
+
+  describe "api" do
+    it "returns a (default) api object" do
+      subject.api.must_be_instance_of Filmtipset::Api
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require "minitest/autorun"
+require "minitest/spec"
+require "minitest/pride"
+
+require_relative "../lib/filmtipset"

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: filmtipset
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Hellberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- peter@c7.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- filmtipset.gemspec
+- lib/filmtipset.rb
+- lib/filmtipset/api.rb
+- lib/filmtipset/api/genre.rb
+- lib/filmtipset/version.rb
+- spec/filmtipset_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/peterhellberg/skatteverket
+licenses:
+- MIT
+metadata: {}
+post_install_message: |2+
+
+  You need an access key in order to use this gem.
+
+      Required setup: Filmtipset.access_key = 'your_access_key'
+
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: API client for the Filmtipset API (requires access key)
+test_files:
+- spec/filmtipset_spec.rb
+- spec/spec_helper.rb