ratsit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8fe41a466ccf397de54bac8fb52e76f96ada4bac
+  data.tar.gz: c81222eb134bd582d1c5b708dff6bfddc14b03c6
+SHA512:
+  metadata.gz: e33317326a6c442affc955fc4dda650e43495b205ff22e394ea487d71ac47598c0e5584d8bede38a6531a14d71cc34eb580d662ccdc340eab3289fcaf0adf3d0
+  data.tar.gz: f15ac274848fe9da25ebceccca9c472ed1be104fabe49658c03edf4ebf0c6ff886f55de5fc6c185cfb3a482586095a39901cd4d7bf20c6d86c1f9b23221562eb

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+*~
+*.gem

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Stefan Nyman
+
+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,41 @@
+# Ratsit
+
+Ruby gem for performing Ratsit searches.
+
+_Note_: This gem is under active development and might not be suitable for use yet...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ratsit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ratsit
+
+## Usage
+
+Coming...
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/qoorp/ratsit.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task :default => :spec
+
+task :console do
+  exec "irb -r ratsit -I ./lib"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ratsit"
+
+# 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/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ratsit.rb

@@ -0,0 +1,82 @@
+require 'ratsit/version'
+require 'ratsit/package'
+require 'ratsit/search_type'
+require 'ratsit/request'
+require 'ratsit/filters'
+require 'ratsit/errors'
+require 'json'
+
+module Ratsit
+
+  api_key_key = 'RATSIT_API_KEY'
+  @env_api_key = ENV[api_key_key]
+  if @env_api_key.nil?
+    puts "No api key specified. The library can only search using the open api. Set your api key using key #{api_key_key}"
+  end
+
+  class RatsitSearch
+
+    attr_reader :filter
+    attr_reader :results
+
+    def initialize(search_type, filter_instance)
+      @filter = filter_instance
+      @search_type = search_type
+      @results = nil
+      @api_key = @env_api_key
+    end
+
+    def search(search_arg, search_area='')
+      if !search_arg.is_a?(String)
+        raise RatsitError, 'Invalid search argument'
+      end
+      if search_arg.length == 0
+        raise RatsitError, 'Invalid search argument length'
+      end
+      if !search_area.is_a?(String)
+        raise RatsitError, 'Invalid search area'
+      end
+      request_class = (!@api_key.nil?)? Ratsit::RatsitTokenRequest: Ratsit::RatsitOpenRequest
+      @request = request_class.new(search_arg, search_area, @search_type, @filter)
+      @request.exec()
+      # check this...
+      if @request.response_ok
+        #puts "response ok"
+        #@results = @request.response_body.to_json
+        @results = @request.response_body
+      else
+        @results = nil
+      end
+      @results
+    end
+
+  end
+
+  class PersonSearch < RatsitSearch
+
+    def initialize()
+      super(Ratsit::SEARCH_TYPE_PERSON, Ratsit::PersonFilter.new())
+      self
+    end
+
+  end
+
+  class CompanySearch < RatsitSearch
+
+    def initialize()
+      super(Ratsit::SEARCH_TYPE_COMPANY, Ratsit::CompanyFilter.new())
+      self
+    end
+
+  end
+
+  class EstateSearch < RatsitSearch
+
+    def initialize()
+      super(Ratsit::SEARCH_TYPE_ESTATE, Ratsit::EstateFilter.new())
+      self
+    end
+
+  end
+
+end

data/lib/ratsit/errors.rb

@@ -0,0 +1,10 @@
+
+class RatsitError < StandardError
+end
+
+class RatsitRequestError < RatsitError
+end
+
+class RatsitFilterError < RatsitError
+end
+

data/lib/ratsit/filters.rb

@@ -0,0 +1,155 @@
+
+require 'ratsit/errors'
+require 'json'
+
+module Ratsit
+
+  # Person filters
+  FILTER_MARRIED = 'Married'
+  FILTER_UNMARRIED = 'Unmarried'
+  FILTER_MALE = 'Male'
+  FILTER_FEMALE = 'Female'
+  FILTER_COMPANY_ENGAGEMENT = 'CompanyEngagement'
+  FILTER_NO_COMPANY_ENGAGEMENT = 'NoCompanyEngagement'
+  FILTER_AGE_FROM = 'AgeFrom'
+  FILTER_AGE_TO = 'AgeTo'
+
+  # Company filters
+  FILTER_AB = 'AB'
+  FILTER_EF = 'EF'
+  FILTER_HB = 'HB'
+  FILTER_OTHER = 'Other'
+
+
+  class RatsitFilter
+
+    def initialize()
+      @active_filters = {}
+      @filter_defaults = {}
+    end
+
+    def active_filters
+      return (@active_filters.nil?)? nil: @active_filters
+    end
+
+    def to_json
+      af = self.active_filters
+      return '{}' if af.nil?
+      af.to_json
+    end
+
+    def update(filter_key='', filter_value)
+      #puts "update #{filter_key}: #{filter_value}"
+      if !filter_key.is_a?(String)
+        raise RatsitFilterError, 'Invalid filter key'
+      end
+      if filter_value.nil?
+        raise RatsitFilterError, 'Invalid filter value'
+      end
+      if !@active_filters.has_key?(filter_key)
+        raise RatsitFilterError, 'Non-existent filter key'
+      end
+      @curr_filters = Marshal.load(Marshal.dump(@active_filters))
+      @curr_filters[filter_key] = filter_value
+      @active_filters = validate_filters(@filter_defaults, @curr_filters)
+    end
+
+    def reset(filter_name='')
+      if !filter_name.is_a?(String)
+        raise RatsitFilterError, 'Invalid filter key'
+      end
+      if !@filter_defaults.has_key?(filter_name)
+        raise RatsitFilterError, 'Non-existent filter key'
+      end
+      @active_filters[filter_name] = @filter_defaults[filter_name][:default]
+    end
+
+  end
+
+  class PersonFilter < RatsitFilter
+    include Ratsit
+    #{"Married":true,"Unmarried":true,"Male":true,"Female":true,"CompanyEngagement":true,"NoCompanyEngagement":true,"AgeFrom":"0","AgeTo":"150"}
+    def initialize(filters={})
+      super()
+      @filter_defaults = {
+          FILTER_MARRIED => {:parse => method(:parse_bool), :default => true},
+          FILTER_UNMARRIED => {:parse => method(:parse_bool), :default => true},
+          FILTER_MALE => {:parse => method(:parse_bool), :default => true},
+          FILTER_FEMALE => {:parse => method(:parse_bool), :default => true},
+          FILTER_COMPANY_ENGAGEMENT => {:parse => method(:parse_bool), :default => true},
+          FILTER_NO_COMPANY_ENGAGEMENT => {:parse => method(:parse_bool), :default => true},
+          FILTER_AGE_FROM => {:parse => method(:parse_age), :default => '0'},
+          FILTER_AGE_TO => {:parse => method(:parse_age), :default => '150'}
+      }
+      @active_filters = validate_filters(@filter_defaults, filters)
+    end
+  end
+
+  class CompanyFilter < RatsitFilter
+    include Ratsit
+    #{"AB":true,"EF":true,"HB":true,"Other":true}
+    def initialize(filters={})
+      super()
+      @filter_defaults = {
+        FILTER_AB => {:parse => method(:parse_bool), :default => true},
+        FILTER_EF => {:parse => method(:parse_bool), :default => true},
+        FILTER_HB => {:parse => method(:parse_bool), :default => true},
+        FILTER_OTHER => {:parse => method(:parse_bool), :default => true}
+      }
+      @active_filters = validate_filters(@filter_defaults, filters)
+    end
+  end
+
+  class EstateFilter < RatsitFilter
+    include Ratsit
+    def initialize()
+      raise NotImplementedError, 'Functionality doesn\'t exist'
+    end
+  end
+
+  private
+
+  def parse_bool(arg)
+    return arg if arg.is_a?(TrueClass) || arg.is_a?(FalseClass)
+    raise RatsitFilterError, 'Invalid bool representation' if !arg.is_a?(String)
+    return true if arg.downcase == 'true'
+    return false if arg.downcase == 'false'
+    raise RatsitFilterError, 'Invalid textual bool value'
+  end
+
+  def parse_age(arg)
+    if arg.is_a?(String)
+      if !(arg =~ /^[0-9]+$/)
+        raise RatsitFilterError, 'Invalid age in filter'
+      end
+      larg = arg.to_i
+    elsif arg.is_a?(Integer)
+      larg = arg
+    else
+      raise RatsitFilterError, 'Invalid arg type in filter'
+    end
+    # ratsit specifies these ages.
+    if larg < 0 || larg > 150
+      raise RatsitFilterError, 'Invalid age'
+    end
+    return "#{larg}"
+  end
+
+  def validate_filters(filter_defaults={}, filters={})
+    if !filters.is_a?(Hash)
+      filters = {}
+    end
+    filters.reject! { |k,_| !filter_defaults.keys.include? k }
+    filter_defaults.each do |filter_name, defs|
+      if !filters.keys.include? filter_name
+        filters[filter_name] = defs[:default]
+      end
+      filters[filter_name] = defs[:parse].call(filters[filter_name])
+    end
+    if filters[FILTER_AGE_TO].to_i < filters[FILTER_AGE_FROM].to_i
+      raise RatsitFilterError, 'Invalid age span'
+    end
+    return filters
+  end
+
+end

data/lib/ratsit/monkey.rb

@@ -0,0 +1,10 @@
+
+class String
+  def underscore
+    self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+  end
+end

data/lib/ratsit/package.rb

@@ -0,0 +1,22 @@
+
+module Ratsit
+  PACKAGE_SMALL_1 = 'small 1'
+  PACKAGE_SMALL_2 = 'small 2'
+  PACKAGE_SMALL_3 = 'small 3'
+  PACKAGE_REMARK  = 'anmarkning'
+  PACKAGE_MEDIUM  = 'medium'
+  PACKAGE_LARGE   = 'large'
+
+  def Ratsit.validate_package(package)
+    raise RatsitError, 'Invalid package argument type' if !package.is_a?(String)
+    return [
+        PACKAGE_SMALL_1,
+        PACKAGE_SMALL_2,
+        PACKAGE_SMALL_3,
+        PACKAGE_REMARK,
+        PACKAGE_MEDIUM,
+        PACKAGE_LARGE
+    ].include?(package)
+  end
+
+end

data/lib/ratsit/person.rb

@@ -0,0 +1,39 @@
+
+require 'ratsit/monkey'
+require 'ratsit/errors'
+
+module Ratsit
+
+  class Person
+
+    def initialize(json_obj)
+      if !json_obj.is_a?(Hash)
+        raise RatsitError, 'Invalid Person initializer'
+      end
+      @json_source = json_obj
+      json_obj.each do |k, v|
+        case k
+          when 'FirstName'
+            v.gsub!("<b>", "")
+            v.gsub!("</b>", "")
+          when 'Gender'
+            v = v.gsub("icon_", "")
+            v = v.gsub(".png", "")
+          when 'Married'
+            v = v.gsub("icon_", "")
+            v = v.gsub(".png", "")
+          when 'CompanyEngagement'
+            v = v.gsub("icon_", "")
+            v = v.gsub(".png", "")
+          else
+            v = v
+        end
+        self.class.send(:define_method, k.underscore) {
+          return v
+        }
+      end
+    end
+
+  end
+
+end

data/lib/ratsit/request.rb

@@ -0,0 +1,80 @@
+
+require 'faraday'
+require 'uri'
+require 'json'
+require 'ratsit/errors'
+require 'ratsit/filters'
+require 'ratsit/search_type'
+
+module Ratsit
+
+  class RatsitRequest
+
+    def initialize()
+
+    end
+
+    def exec()
+      uri = self.build_uri
+      conn = Faraday.new(:url => "http://#{uri.host}")
+      #puts "http://#{uri.host}"
+      #puts self.compose_request_body
+      @response = conn.post do |req|
+        req.url uri.request_uri
+        req.headers['Content-Type'] = 'application/json'
+        req.body = self.compose_request_body
+      end
+      #puts @response.body
+      #puts @response.status
+    end
+
+    def response_ok
+      return false if @response.nil?
+      return @response.status == 200
+    end
+
+    def response_body
+      return nil if @response.nil?
+      return @response.body
+    end
+  end
+
+  class RatsitOpenRequest < RatsitRequest
+
+    def initialize(search_term, search_area, search_type, filters)
+      super()
+      if search_type == Ratsit::SEARCH_TYPE_ESTATE
+        raise RatsitRequestError, 'Estate search is not available in open api'
+      end
+      @base_url = 'http://www.ratsit.se/BC/SearchSimple.aspx/'
+      @search_term = search_term
+      @search_area = search_area
+      @search_type = search_type
+      @search_filter = filters
+      self
+    end
+
+    def build_uri
+      if !Ratsit.validate_search_type(@search_type)
+        raise RatsitRequestError, 'Invalid search type'
+      end
+      URI.parse("#{@base_url}#{@search_type}")
+    end
+
+    def compose_request_body
+      {
+          'who': @search_term,
+          'where': @search_area,
+          'filter': @search_filter.to_json
+      }.to_json
+    end
+
+  end
+
+  class RatsitTokenRequest < RatsitRequest
+    def initialize()
+      raise NotImplementedError, 'Token requests are not supported yet'
+    end
+  end
+
+end

data/lib/ratsit/search_type.rb

@@ -0,0 +1,19 @@
+
+require 'ratsit/errors'
+
+module Ratsit
+
+  SEARCH_TYPE_PERSON  = 'PersonSearch'
+  SEARCH_TYPE_COMPANY = 'CompanySearch'
+  SEARCH_TYPE_ESTATE  = 'EstateSearch'
+
+  def Ratsit.validate_search_type(search_type)
+    raise RatsitError, 'Invalid search_type argument' if !search_type.is_a?(String)
+    return [
+        SEARCH_TYPE_PERSON,
+        SEARCH_TYPE_COMPANY,
+        SEARCH_TYPE_ESTATE
+    ].include?(search_type)
+  end
+
+end

data/lib/ratsit/version.rb

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

data/ratsit.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ratsit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ratsit"
+  spec.version       = Ratsit::VERSION
+  spec.authors       = ["Stefan Nyman"]
+  spec.email         = ["stefan@qoorp.com"]
+
+  spec.summary       = "Ratsit searches..."
+  spec.description   = "Ratsit searches..."
+  spec.homepage      = "http://github.com/qoorp/ratsit"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+
+  spec.add_runtime_dependency "faraday", "~> 0.9.2"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: ratsit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stefan Nyman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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
+description: Ratsit searches...
+email:
+- stefan@qoorp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ratsit.rb
+- lib/ratsit/errors.rb
+- lib/ratsit/filters.rb
+- lib/ratsit/monkey.rb
+- lib/ratsit/package.rb
+- lib/ratsit/person.rb
+- lib/ratsit/request.rb
+- lib/ratsit/search_type.rb
+- lib/ratsit/version.rb
+- ratsit.gemspec
+homepage: http://github.com/qoorp/ratsit
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.1
+signing_key: 
+specification_version: 4
+summary: Ratsit searches...
+test_files: []