edesky-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5d2abe471a35f4380ced646a9fa214b07c83606
+  data.tar.gz: 2368b2c312e54b8b3016b4b29de498d495d5ccc8
+SHA512:
+  metadata.gz: c3c2213c3a55952b940b4a240f746de5ec607c2163c9c54a99fbbc3def7f728c6ae9072ff5965deeb97d0af40688e0e716089194320eae7ca377e503215fb971
+  data.tar.gz: af2c0a1c95470dc937c96caaa6b8a28f1872f3dcb75b85d2c094ea118ef70de6c146923f980dcb0ca885888c77289004d693854564b9b215aa1c0105c2bc96cd

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle
+/log/*
+.idea
+.rvmrc
+/nbproject
+/.nbproject
+.DS_Store
+.*~
+.~lock.*#
+.directory

data/README.md

@@ -0,0 +1,24 @@
+Ruby klient pro edesky.cz API
+============================
+
+**Ve vývoji.**
+
+Informace o obecném HTTP API najdete na https://github.com/edesky/edesky_api
+
+Příklad použití
+---------------
+
+```bash
+gem install edesky-client
+```
+
+```ruby
+require 'edesky_client'
+
+client = EdeskyClient.new(api_key: '')
+
+response = client.query_documents(keywords: 'prodej')
+
+# vypsat prvni nalezeny dokument
+p response['documents']['document'][0]
+```

data/edesky-client.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = 'edesky-client'
+  s.version     = '0.0.1'
+  s.date        = '2015-11-21'
+  s.summary     = "Ruby klient pro edesky.cz API"
+  s.description = "Ruby klient pro edesky.cz HTTP API, hledání dokumentů a úředních desek."
+  s.authors     = ["Marek Aufart"]
+  s.email       = 'aufi.cz@gmail.com'
+  s.files       = `git ls-files`.split($\)
+  s.test_files    = s.files.grep(%r{spec/})
+  s.require_paths = ["lib"]
+  s.homepage    = 'https://github.com/edesky/edeskyclient_ruby'
+  s.license     = 'MIT'
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'simplexml', '~> 1.1'
+  s.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/edesky_client.rb

@@ -0,0 +1,66 @@
+# The MIT License (MIT)
+# Copyright (c) 2015 Marek Aufart, edesky.cz
+# 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.
+
+require 'net/http'
+require 'xmlsimple'
+
+class EdeskyClient
+
+  CLIENT_DEFAULTS = {
+    endpoint_url: 'https://edesky.cz/api/v1/',
+    api_key: ''
+  }
+
+  DOC_QUERY_DEFAULTS = {
+    keywords: '*',
+    include_texts: 0
+  }
+
+  BOARD_QUERY_DEFAULTS = {}
+
+  def initialize(options = {})
+    CLIENT_DEFAULTS.merge(options).each do |option, value|
+      instance_variable_set("@#{option}", value)
+    end
+  end
+
+  def query_documents(options = {})
+    fetch('documents', DOC_QUERY_DEFAULTS.merge(options))
+  end
+
+  def query_dashboards(options = {})
+    raise "Not implemented yet!"
+  end
+
+  private
+
+  def fetch(type, params)
+    uri = URI(URI.join(@endpoint_url, type))
+    uri.query = URI.encode_www_form(params)
+    XmlSimple.xml_in(Net::HTTP.get(uri), 'ForceArray': false)
+  end
+
+end
+
+=begin
+# Example:
+client = EdeskyClient.new(api_key: '')
+response = client.query_documents(keywords: 'prodej')
+# print first found document
+p response['documents']['document'][0]
+=end

data/test/documents_output.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="utf-8"?><edesky_search_api version="0.9">
+<meta>
+<timestamp>2015-08-01 07:31:12 +0200</timestamp>
+<user>marek@aurem.cz</user>
+<requested_params>{"keywords"=>"prodej", "created_from"=>"2015-06-01", "order"=>"date", "search_with"=>"sql", "api_key"=>"cs9r20T5rDr9dEFW1N9IFv8fpH7YN4PF", "page"=>"1", "format"=>"xml"}</requested_params>
+<documents_count total="1622">200</documents_count>
+<page total="9">1</page>
+</meta>
+<documents>
+<document created_at="2015-07-31 17:19:39 +0200" dashboard_id="385" dashboard_name="Město Hluk" edesky_id="191444" edesky_text_url="https://edesky.cz/dokument/191444.txt" edesky_url="https://edesky.cz/dokument/191444" name="Zveřejněno 31.07.2015 - Záměr o prodeji části pozemků v ulici Pod Sádkama a v ulici Mladá.pdf" orig_url="http://www.mestohluk.cz/doc/930/element/67173/download">
+<attachments>
+<attachment contains_text="1" edesky_id="212424" mimetype="application/pdf" name="Zveřejněno 31.07.2015 - Záměr o prodeji části pozemků v ulici Pod Sádkama a v ulici Mladá.pdf" url="https://edesky.cz/attachments/2015_w30/385_212424/open-uri20150731-11087-ffz5q5">
+
+</attachment>
+</attachments>
+</document>
+<document created_at="2015-07-31 17:19:24 +0200" dashboard_id="362" dashboard_name="Město Holýšov" edesky_id="191436" edesky_text_url="https://edesky.cz/dokument/191436.txt" edesky_url="https://edesky.cz/dokument/191436" name="Výběrové řízení-prodej nemovitosti č.p.38 Vránov" orig_url="http://www.mestoholysov.cz/uredni-deska/vyberove-rizeni-prodej-nemovitosti-cp38-vranov-278.html">
+<attachments>
+<attachment contains_text="1" edesky_id="212398" mimetype="application/pdf" name="Výběrové řízení-prodej nemovitosti č.p.38 Vránov" url="https://edesky.cz/attachments/2015_w30/362_212398/open-uri20150731-11087-kmgf98">
+
+</attachment>
+</attachments>
+</document>
+</documents>
+</edesky_search_api>

data/test/test_edesky_client.rb

@@ -0,0 +1,13 @@
+require 'minitest/autorun'
+require_relative '../lib/edesky_client'
+
+# client test
+class TestEdeskyClient < Minitest::Test
+  def setup
+    @client = EdeskyClient.new
+  end
+
+  def test_get_documents
+    raise "TODO tests"
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: edesky-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marek Aufart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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: Ruby klient pro edesky.cz HTTP API, hledání dokumentů a úředních desek.
+email: aufi.cz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- edesky-client.gemspec
+- lib/edesky_client.rb
+- test/documents_output.xml
+- test/test_edesky_client.rb
+homepage: https://github.com/edesky/edeskyclient_ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby klient pro edesky.cz API
+test_files: []