transparent_data-rb 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdb82eceff80959973b79ac2ac2eb2f70c3f304cc871eea6afec0ca68f052923
-  data.tar.gz: 3bd9b51316d4793062bdb42a9aa21b00874d1fab976d45d1114b0687d66d88ec
+  metadata.gz: a4a8f55fa7433e0e315d2bbb74b17105bdbb26f547e68cd3e4e869d81a98b836
+  data.tar.gz: 710a59a70647472ac85a443af84a6f5a1fd21b5e9d657a562625c2f5e9d82f14
 SHA512:
-  metadata.gz: eae69543829933e695001af6c663a8a6e6a6ebfacd770c145e2d1cad87ffb36b81cc4e07ad86aaa74bfc930e4cd00f1d39db646f64237cb704eb2720d0e41584
-  data.tar.gz: 689417247a6e2d4cf130b713257b7672865a11334345c2b7c51e20acbd6f061253b5ed888164517a5ca156cf8c0e99e11ab4cca78aa0eb534046fad97b4eb3f6
+  metadata.gz: 8a93674569fbb5dddd85e95635beff0fbda36e8a3ccd380f89d27eda11c6e368bbf7b4c9fed0fab7335565c806ed1da198310860522e10fda9cde47e81a48af3
+  data.tar.gz: f6390304fb55dcfb2bccfe77a2f979606b3bd60d9e2efea44da569e3967192b9761498164d403c63222d933f4fde4d0d769eb4d2272ab7eb61f571d3b59c4b1f

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.7)
       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,13 +1,14 @@
 require 'faraday'
+require 'json'
 
 require 'transparent_data/version'
 require 'transparent_data/exceptions'
 require 'transparent_data/configurable'
-require 'transparent_data/module_functions'
+require 'transparent_data/actions'
 
 module TransparentData
   extend TransparentData::Configurable
-  extend TransparentData::ModuleFunctions
+  extend TransparentData::Actions
 
   initialize_config_accessors(:url, :user, :password, :key)
 end

data/lib/transparent_data/actions.rb

@@ -0,0 +1,28 @@
+require 'transparent_data/request'
+require 'transparent_data/actions/search'
+require 'transparent_data/actions/add'
+require 'transparent_data/actions/result'
+
+module TransparentData
+  module Actions
+    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
+
+    def client
+      @client ||= Faraday.new(TransparentData.url) do |conn|
+        conn.basic_auth(TransparentData.user, TransparentData.password)
+      end
+    end
+  end
+end

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/request.rb

@@ -2,32 +2,25 @@ require 'transparent_data/response/struct'
 
 module TransparentData
   class Request
-    QUERY_PARAM = :q
+    class << self
+      def call(client, method, query: {}, json: {})
+        response = client.post(build_path(method, query), json.to_json)
 
-    COUNTRY_TO_KEY_MAP = {
-      finland: :fi,
-      czech: :cz,
-      denmark: :dk,
-      norway: :no,
-      slovakia: :sk,
-      uk: :uk
-    }.freeze
+        TransparentData::Response::Struct.new(response)
+      end
 
-    def self.call(client, country, query)
-      response = client.post(build_path(country, query))
+      private
 
-      TransparentData::Response::Struct.new(response)
-    end
+      def build_path(method, query)
+        base_path = "/#{TransparentData.key}/#{method}"
 
-    private
+        return base_path unless query&.any?
 
-    def build_path(country, query)
-      "/#{TransparentData.key}/#{fetch_country_id(country)}Search?#{QUERY_PARAM}=#{query}"
-    end
+        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}"
+      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.2'.freeze
+  VERSION = '0.1.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transparent_data-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 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
@@ -114,9 +114,12 @@ files:
 - bin/console
 - bin/setup
 - lib/transparent_data.rb
+- lib/transparent_data/actions.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
 - lib/transparent_data/request.rb
 - lib/transparent_data/response/struct.rb
 - lib/transparent_data/version.rb

data/lib/transparent_data/module_functions.rb

@@ -1,17 +0,0 @@
-require 'transparent_data/request'
-
-module TransparentData
-  module ModuleFunctions
-    def search(country, query)
-      TransparentData::Request.call(client, country, query)
-    end
-
-    private
-
-    def client
-      @client ||= Faraday.new(TransparentData.url) do |conn|
-        conn.basic_auth(TransparentData.user, TransparentData.password)
-      end
-    end
-  end
-end