transparent_data-rb 0.1.0 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d6324a6d674bfe9b41b0f5265814278ac6896e1b5f8d81f47182a98e0e6b55f
-  data.tar.gz: c9f116dcb04e6e8bdf9a53eb6e2ab8b1dbfc23078b886e2a40a3168b0ee76712
+  metadata.gz: c5af41cd1106275ad10b7ca0eafa1871651d4967ba1e1a6f00d04fa826ca01b9
+  data.tar.gz: 9d0a797a052a03d8cb57e4faba99fa094c3cc29017804d2a4f9d91e3095a5454
 SHA512:
-  metadata.gz: 0c37b343915a9aa87faeec773c3e44c0ea730ce72a474519ca9cd4d6db392de844e25e5c337597380eac33cfe3ffa58e89a033cbde2d2ad3f5bdc53041d53159
-  data.tar.gz: c29f27c94b096d5caca03a5dbc5d9b2972e1b8bfa8fd7860d05e106f98a670976d8e28a92fbd082ae4d51e6afeb668f24a205558b5c9ce4f0c08ea5257231d1a
+  metadata.gz: 183407be095e12dee5d5fc0fd3a6a9357f1992f08bd6375d38e109e4f0523b8b6eed3fd069984712126c3bd3c4beb2ef5aceba7ae61dc864b8806960c2a88dd7
+  data.tar.gz: 2a7f1b56290e4a9331f32df1025acf481588cb5c7460714cb85035ac572807c43861a2aed8368ae9023c1d9a66ae56a37cfb41ed0504a26da55f4d32ac1949ed

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+transparent_data-rb-*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    transparent_data-rb (0.0.1)
+    transparent_data-rb (0.1.6)
       bundler (~> 2.1)
       faraday
       rake (~> 13.0)

data/README.md

@@ -1,44 +1,56 @@
-# TransparentData
+# TransparentData RB
+[![Gem Version](https://badge.fury.io/rb/transparent_data-rb.svg)](https://badge.fury.io/rb/transparent_data-rb) [![Build Status](https://travis-ci.com/sigmen/transparent_data-rb.svg?branch=master)](https://travis-ci.com/sigmen/transparent_data-rb)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/transparent_data`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Supports
 
-TODO: Delete this and the text above, and describe your gem
+Ruby `>= 2.4`.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'transparent_data-rb'
-```
+    gem 'transparent_data-rb'
 
 And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+Or install with:
 
     $ gem install transparent_data-rb
 
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Usage
 
-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
+```ruby
+response = TransparentData.search(country_name, query)
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/transparent_data-rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/transparent_data-rb/blob/master/CODE_OF_CONDUCT.md).
+response.body # => [{...}]
+response.status # => 200
+response.headers # => {...}
+```
 
+#### Search options
+* country_name - Any available country name (see Available countries)
+* query - Search query
 
-## License
+#### Available countries
+Gem supports all available Transparentdata.eu countries:
+* finland
+* uk
+* denmark
+* norway
+* slovakia
+* czech
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+#### Configuration
 
-## Code of Conduct
+Before using gem you need to configure some parameters:
 
-Everyone interacting in the TransparentData project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/transparent_data-rb/blob/master/CODE_OF_CONDUCT.md).
+```ruby
+TransparentData.configure do |config|
+    config.url = 'https://transparentdata.eu/' # You can using any another url for test environment
+    config.user = 'user' # Username for HTTP Basic
+    config.password = 'password' # Password for HTTP Basic
+    config.key = 'key' # API Key
+end
+```

data/lib/transparent_data.rb

@@ -1,8 +1,10 @@
 require 'faraday'
+require 'json'
 
 require 'transparent_data/version'
 require 'transparent_data/exceptions'
 require 'transparent_data/configurable'
+require 'transparent_data/request'
 require 'transparent_data/module_functions'
 
 module TransparentData

data/lib/transparent_data/actions/add.rb

@@ -0,0 +1,28 @@
+module TransparentData
+  module Actions
+    class Add
+      attr_reader :client, :source, :method, :parameters
+
+      def initialize(client, source, method, parameters)
+        @client = client
+        @source = source
+        @method = method
+        @parameters = parameters
+      end
+
+      def call
+        TransparentData::Request.call(client, 'add', json: build_json)
+      end
+
+      private
+
+      def build_json
+        {
+          source: source,
+          method: method,
+          parameters: parameters
+        }
+      end
+    end
+  end
+end

data/lib/transparent_data/actions/result.rb

@@ -0,0 +1,22 @@
+module TransparentData
+  module Actions
+    class Result
+      attr_reader :client, :ident
+
+      def initialize(client, ident)
+        @client = client
+        @ident = ident
+      end
+
+      def call
+        TransparentData::Request.call(client, 'result', query: build_query(ident))
+      end
+
+      private
+
+      def build_query
+        { ident: ident }
+      end
+    end
+  end
+end

data/lib/transparent_data/actions/search.rb

@@ -0,0 +1,40 @@
+module TransparentData
+  module Actions
+    class Search
+      COUNTRY_TO_KEY_MAP = {
+        finland: :fi,
+        czech: :cz,
+        denmark: :dk,
+        norway: :no,
+        slovakia: :sk,
+        uk: :uk
+      }.freeze
+
+      attr_reader :client, :country, :query_str
+
+      def initialize(client, country, query_str)
+        @client = client
+        @country = country
+        @query_str = query_str
+      end
+
+      def call
+        search_method = "#{fetch_country_id(country)}Search"
+
+        TransparentData::Request.call(client, search_method, query: build_query(query_str))
+      end
+
+      private
+
+      def build_query(query_str)
+        { q: query_str }
+      end
+
+      def fetch_country_id(country)
+        COUNTRY_TO_KEY_MAP.fetch(country.to_s.downcase.to_sym) do
+          raise TransparentData::UnknownCountryError, "Unknown country: #{country.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/transparent_data/configurable.rb

@@ -14,7 +14,7 @@ module TransparentData
           end
 
           define_singleton_method("#{attr}=") do |value|
-            public_send(attr) || instance_variable_set("@#{attr}", value)
+            instance_variable_get("@#{attr}") || instance_variable_set("@#{attr}", value)
           end
         end
       end

data/lib/transparent_data/module_functions.rb

@@ -1,9 +1,20 @@
 require 'transparent_data/request'
+require 'transparent_data/actions/search'
+require 'transparent_data/actions/add'
+require 'transparent_data/actions/result'
 
 module TransparentData
   module ModuleFunctions
-    def search(country, query)
-      TransparentData::Request.call(client, country, query)
+    def search(country, query_str)
+      TransparentData::Actions::Search.new(client, country, query_str).call
+    end
+
+    def add(source, method, parameters)
+      TransparentData::Actions::Add.new(client, source, method, parameters).call
+    end
+
+    def result(ident)
+      TransparentData::Actions::Result.new(client, ident).call
     end
 
     private

data/lib/transparent_data/request.rb

@@ -2,33 +2,24 @@ require 'transparent_data/response/struct'
 
 module TransparentData
   class Request
-    QUERY_PARAM = :q
-
-    COUNTRY_TO_KEY_MAP = {
-      finland: :fi,
-      czech: :cz,
-      denmark: :dk,
-      norway: :no,
-      slovakia: :sk,
-      uk: :uk
-    }.freeze
-
-    def self.call(client, country, query)
-      response = client.post(build_path(country, query))
+    def self.call(client, method, query: {}, json: {})
+      response = client.post(build_path(method, query), json)
 
       TransparentData::Response::Struct.new(response)
     end
 
     private
 
-    def build_path(country, query)
-      "/#{TransparentData.key}/#{fetch_country_id(country)}Search?#{QUERY_PARAM}=#{query}"
+    def build_path(method, query)
+      base_path = "/#{TransparentData.key}/#{method}"
+
+      return base_path unless query&.any?
+
+      base_path.concat("?#{convert_params_to_query(query)}")
     end
 
-    def fetch_country_id(country)
-      COUNTRY_TO_KEY_MAP.fetch(country.to_sym) do
-        raise TransparentData::UnknownCountryError, "Unknown country: #{country.inspect}"
-      end
+    def convert_params_to_query(params)
+      params.map { |pair| pair.join('=') }.join('&')
     end
   end
 end

data/lib/transparent_data/response/struct.rb

@@ -3,11 +3,17 @@ module TransparentData
     class Struct
       extend Forwardable
 
-      def_delegators :@response, :body, :headers, :status
+      def_delegators :@response, :headers, :status, :success?
 
       def initialize(response)
         @response = response
       end
+
+      def body
+        JSON.parse(@response.body)
+      rescue JSON::ParserError
+        @response.body
+      end
     end
   end
 end

data/lib/transparent_data/version.rb

@@ -1,3 +1,3 @@
 module TransparentData
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.6'.freeze
 end

data/transparent_data.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Roman Kakorin']
   spec.email         = ['romchky1@gmail.com']
 
-  spec.summary       = 'Gem implements multitable iheritance.'
-  spec.description   = 'Gem implements multitable iheritance.'
+  spec.summary       = 'https://transparentdata.eu API client'
+  spec.description   = 'https://transparentdata.eu API client'
   spec.homepage      = 'https://github.com/sigmen/transparent_data-rb'
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 2.4.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transparent_data-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.6
 platform: ruby
 authors:
 - Roman Kakorin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2020-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Gem implements multitable iheritance.
+description: https://transparentdata.eu API client
 email:
 - romchky1@gmail.com
 executables: []
@@ -114,6 +114,9 @@ files:
 - bin/console
 - bin/setup
 - lib/transparent_data.rb
+- lib/transparent_data/actions/add.rb
+- lib/transparent_data/actions/result.rb
+- lib/transparent_data/actions/search.rb
 - lib/transparent_data/configurable.rb
 - lib/transparent_data/exceptions.rb
 - lib/transparent_data/module_functions.rb
@@ -146,5 +149,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: Gem implements multitable iheritance.
+summary: https://transparentdata.eu API client
 test_files: []