gillbus-v2 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0b1da1daa5d8dbad4918b9924877bb40492c30b4557daa20464505493b9d78b
-  data.tar.gz: 5ffe4476faafc56d9fca5803b8f45651a5cb14a6ea5a80ace63d9b126ddd2168
+  metadata.gz: e492282b609d3c3b20ad09f90a14def0027ace86577f4fc5f38152f7aef7646e
+  data.tar.gz: 4a0ab148b572b5dbb982a73d6462371070a1fec9ca8e9d83d4446bd599e338c3
 SHA512:
-  metadata.gz: 7ff084e7e3e8cd633467e573f500e5df9d501065b71ba2c5a3126962fef7a33002b8bbd27d2d8ebc6c4886b28326b62d317220136e4111bc93944c292975317c
-  data.tar.gz: a87780270f9bd71b62009114c2dff5c0a88a5b4d1422c57dda33ad96131a599bfde6acf73b1355ee615d9ee72b2c235fb748edde24849f48f6e38dc8c398f3a0
+  metadata.gz: c59e9c4d3f612f2e5f01d865fabc123a20ca0d6ec7d0f77eaee5c57a6ee08efd42fbb5f7a123d6a7657600d3c54b920295d4f29a13130ebb22b2029b11685944
+  data.tar.gz: f646e149e2dda7b7f82dc0e9cf7f886aeefdc69c2e2133302ead3fa50bd01fc381dff176a6d0082353edfa22be53b509983693dd4457fc177112490ad014c9b1

data/README.md

@@ -78,6 +78,78 @@ end
 
 The method `expired?` returns `false` when there is no info about the token’s expiration time.
 
+### Fetch locations
+
+For fetch the first page you should use method `get_locations`, other pages - `get_locations_page`. For example:
+
+```ruby
+response = client.get_locations(
+  langs: %w[en ru uk pl],
+  limit_for_page: 100,
+)
+# first 100 locations
+response.locations
+
+while response.pagination.next_page
+  response = client.get_locations_page(
+    pagination_uuid: response.pagination.uuid,
+    page_number: response.pagination.next_page,
+  )
+  # other locations by 100 records
+  response.locations
+end
+```
+
+Every response should contain the following data:
+
+```ruby
+# list of locations
+response.locations
+
+# dictionaries
+response.location_types
+response.location_sub_types
+response.location_additional_fields
+
+# usage of dictionaries
+location = response.locations.first
+location_type =
+  response.location_types.detect do |item|
+    item.id == location.type_id
+  end
+location_sub_type =
+  response.location_sub_types.detect do |item|
+    item.id == location.sub_type_id
+  end
+location.additional_fields.each do |field_id, field_value|
+  field =
+    response.location_additional_fields.detect do |item|
+      item.id == field_id
+    end
+  field_name = field.name
+end
+```
+
+Also you can load changes from a certain point of time instead of loading of the whole list. In order to do this you should pass param`from_datetime` to `get_locations`. Only the changed locations will be included in the response.
+
+```ruby
+# get changes for last hour
+response = client.get_locations(
+  langs: %w[en ru uk pl],
+  limit_for_page: 10,
+  from_datetime: DateTime.now - 3600,
+)
+
+while response.pagination.next_page
+  # ...
+end
+```
+
+Each location contains fields:
+
+- `modified_at` - last modification time
+- `deleted` - if true then location has been removed
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/gillbus/v2.rb

@@ -10,6 +10,12 @@ require "gillbus/v2/client"
 require "gillbus/v2/parser"
 require "gillbus/v2/structs/base"
 require "gillbus/v2/structs/access_token"
+require "gillbus/v2/structs/pagination"
+require "gillbus/v2/structs/location"
+require "gillbus/v2/structs/location_type"
+require "gillbus/v2/structs/location_sub_type"
+require "gillbus/v2/structs/location_additional_field"
 
 require "gillbus/v2/responses/base"
 require "gillbus/v2/responses/authenticate"
+require "gillbus/v2/responses/locations"

data/lib/gillbus/v2/client.rb

@@ -41,6 +41,27 @@ module Gillbus::V2
       end
     end
 
+    def get_locations(langs: %w[en], limit_for_page: 50, from_datetime: nil)
+      params = {
+        lang_array: langs,
+        limit: limit_for_page,
+        timestamp: from_datetime&.rfc3339,
+      }
+      call_api(:get, "/geo/v2/locations", params,
+        response_class: Responses::Locations,
+      )
+    end
+
+    def get_locations_page(pagination_uuid:, page_number:)
+      params = {
+        page_uuid: pagination_uuid,
+        number_page: page_number,
+      }
+      call_api(:get, "/geo/v2/locations/page", params,
+        response_class: Responses::Locations,
+      )
+    end
+
     private
 
     def call_api(http_method, url, params, auth_required: true, response_class: Responses::Base)
@@ -56,6 +77,9 @@ module Gillbus::V2
               request.params[key.to_s] = value
             end
             request.headers['accept'] = 'application/json'
+            if auth_required
+              request.headers['Authorization'] = access_token.auth_header
+            end
           end
         rescue Faraday::Error => e
           raise e
@@ -68,6 +92,7 @@ module Gillbus::V2
       @connection ||= Faraday.new(url: base_url) do |faraday|
         faraday.request :url_encoded
         faraday.adapter Faraday.default_adapter
+        faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
       end
     end
   end

data/lib/gillbus/v2/parser.rb

@@ -2,29 +2,51 @@ module Gillbus::V2
   class Parser
     def parse_fields(raw_data, fields_settings)
       result = {}
-      fields_settings.each do |name:, type:, default:|
-        raw_value = raw_data[name.to_s]
-        result[name] =
+      fields_settings.each do |field|
+        if field[:type] == :translations_hash && raw_data["translations"]
+          result[field[:name]] =
+            fetch_from_translations(raw_data["translations"], field[:from])
+          next
+        end
+
+        raw_value = raw_data[field[:from]]
+        result[field[:name]] =
           if raw_value.nil?
-            default
+            field[:default]
           else
-            coerce_value(raw_value, type)
+            coerce_value(raw_value, field[:type])
           end
       end
       result
     end
 
+    private
+
     def coerce_value(value, type)
       case type
+      when :boolean
+        value
       when :string
         value.to_s
       when :integer
         value.to_i
+      when :float
+        value.to_f
+      when :date_time
+        DateTime.rfc3339(value)
       when :date_time_from_timestamp
         DateTime.strptime(value.to_s, "%s")
+      when :translations_hash
+        value.to_h
       else
         raise "Type #{type} not supported"
       end
     end
+
+    def fetch_from_translations(translations, field_name)
+      translations.each_with_object({}) do |item, result|
+        result[item["lang"]] = item[field_name]
+      end
+    end
   end
 end

data/lib/gillbus/v2/responses/locations.rb

@@ -0,0 +1,77 @@
+module Gillbus::V2
+  module Responses
+    class Locations < Responses::Base
+      def locations
+        @locations ||= (json_body["locations"] || []).map do |item|
+          Structs::Location.from_raw_data(item)
+        end
+      end
+
+      def location_types
+        @location_types ||= begin
+          data = formatted_dictionaries["location_types"]&.values || []
+          data.map do |item|
+            Structs::LocationType.from_raw_data(item)
+          end
+        end
+      end
+
+      def location_sub_types
+        @location_sub_types ||= begin
+          data = formatted_dictionaries["location_subtypes"]&.values || []
+          data.map do |item|
+            Structs::LocationSubType.from_raw_data(item)
+          end
+        end
+      end
+
+      def location_additional_fields
+        @location_additional_fields ||= begin
+          data = formatted_dictionaries["location_data_type"]&.values || []
+          data.map do |item|
+            Structs::LocationAdditionalField.from_raw_data(item)
+          end
+        end
+      end
+
+      def pagination
+        @pagination ||=
+          if json_body["pages_info"]
+            Structs::Pagination.from_raw_data(json_body["pages_info"])
+          end
+      end
+
+      private
+
+      def formatted_dictionaries
+        @formatted_dictionaries ||=
+          format_dictionaries(json_body["dictionaries"])
+      end
+
+      def format_dictionaries(dictionaries)
+        result = {}
+        return result unless dictionaries
+
+        dictionaries.each do |lang, dicts|
+          dicts.each do |dict_key, dict|
+            dict.each do |item|
+              item_id = item["id"]
+              result[dict_key] ||= {}
+              result[dict_key][item_id] ||= {}
+              item.each do |item_attr, attr_value|
+                if item_attr == "id"
+                  result[dict_key][item_id][item_attr] ||= attr_value
+                else
+                  result[dict_key][item_id][item_attr] ||= {}
+                  result[dict_key][item_id][item_attr][lang] = attr_value
+                end
+              end
+            end
+          end
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/gillbus/v2/structs/access_token.rb

@@ -17,5 +17,9 @@ module Gillbus::V2
     def to_s
       access_token
     end
+
+    def auth_header
+      "#{token_type} #{access_token}"
+    end
   end
 end

data/lib/gillbus/v2/structs/base.rb

@@ -10,12 +10,13 @@ module Gillbus::V2
         end
       end
 
-      def self.field(name, type, default: nil)
+      def self.field(name, type, from: name, default: nil)
         attr_reader name
         @fields_settings ||= []
         @fields_settings << {
           name: name,
           type: type,
+          from: from.to_s,
           default: default,
         }
       end

data/lib/gillbus/v2/structs/location.rb

@@ -0,0 +1,29 @@
+module Gillbus::V2
+  class Structs::Location < Structs::Base
+    field :id, :integer
+    field :parent_id, :integer
+    field :country_id, :integer
+    field :type_id, :integer
+    field :sub_type_id, :integer, from: "subtype_id"
+
+    field :modified_at, :date_time, from: "date_modified"
+    field :deleted, :boolean
+
+    field :latitude, :float
+    field :longitude, :float
+
+    field :timezone, :string
+
+    field :default_name, :string
+    field :name, :translations_hash
+    field :region_name, :translations_hash
+    field :country_name, :translations_hash
+
+    def additional_fields
+      @additional_fields ||=
+        raw_data["location_data"].each_with_object({}) do |item, result|
+          result[item["id"]] = item["value"]
+        end
+    end
+  end
+end

data/lib/gillbus/v2/structs/location_additional_field.rb

@@ -0,0 +1,6 @@
+module Gillbus::V2
+  class Structs::LocationAdditionalField < Structs::Base
+    field :id, :integer
+    field :name, :translations_hash
+  end
+end

data/lib/gillbus/v2/structs/location_sub_type.rb

@@ -0,0 +1,7 @@
+module Gillbus::V2
+  class Structs::LocationSubType < Structs::Base
+    field :id, :integer
+    field :name, :translations_hash
+    field :short_name, :translations_hash
+  end
+end

data/lib/gillbus/v2/structs/location_type.rb

@@ -0,0 +1,6 @@
+module Gillbus::V2
+  class Structs::LocationType < Structs::Base
+    field :id, :integer
+    field :name, :translations_hash
+  end
+end

data/lib/gillbus/v2/structs/pagination.rb

@@ -0,0 +1,12 @@
+module Gillbus::V2
+  class Structs::Pagination < Structs::Base
+    field :uuid, :string, from: "page_uuid"
+    field :pages_count, :integer, from: "page_count"
+    field :current_page, :integer, from: "page_number"
+    field :expires_in, :integer
+
+    def next_page
+      current_page + 1 if current_page < pages_count
+    end
+  end
+end

data/lib/gillbus/v2/version.rb

@@ -1,5 +1,5 @@
 module Gillbus
   module V2
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gillbus-v2
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Roman Khrebtov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-28 00:00:00.000000000 Z
+date: 2019-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -131,8 +131,14 @@ files:
 - lib/gillbus/v2/parser.rb
 - lib/gillbus/v2/responses/authenticate.rb
 - lib/gillbus/v2/responses/base.rb
+- lib/gillbus/v2/responses/locations.rb
 - lib/gillbus/v2/structs/access_token.rb
 - lib/gillbus/v2/structs/base.rb
+- lib/gillbus/v2/structs/location.rb
+- lib/gillbus/v2/structs/location_additional_field.rb
+- lib/gillbus/v2/structs/location_sub_type.rb
+- lib/gillbus/v2/structs/location_type.rb
+- lib/gillbus/v2/structs/pagination.rb
 - lib/gillbus/v2/version.rb
 homepage: https://github.com/busfor/gillbus-v2-ruby
 licenses: