custplace 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2be54dccd275ef8926687ab0b8f5841539b253333f4184c360690cbbb0a3a4b7
-  data.tar.gz: 6544482930d0f41aebebb15db239e1b50ba997045fde2938898fb710c58b2f0f
+  metadata.gz: f968fdfbb429a78b57e20e0d111af237df2dd3aaa6d91205ef1ee469be6683db
+  data.tar.gz: 0d2881308c38fe25297c83f015d086699c731efe9bae01c6d1ffe1b4ba1fddef
 SHA512:
-  metadata.gz: '0094de765458afad1882c7271cb7824830315e9614d79d6cbe9276f66e5522ee7040963a0a946439bdb82d78de231a55429efc125135606763ddab50ebcdc8c4'
-  data.tar.gz: 82896b6b44c687e028c330223c191c3c92f4b07f101bf9c176bcd4f438f3ffea9f5dd335e1332f9ffe821dd7e092c8ca446235a97e88213c1b8f6680bf30c628
+  metadata.gz: c61fa5ebda18f8495047d5bcca4ba184a67a6cfa8bbf9e442190df3e5780bde601834ae2bb15b23e3e5b27cc52c45fe1681e35122d4fd27025c27a7bf9ac2e9e
+  data.tar.gz: 1ebb030469ba3be87250170c22b5aac92dc89dadf537b2ce50a6eaba7ec0b5ddce0c5f91f90d0113d3961cd6c5d2b911c69754decea3bc3733d4c3f4153c8578

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ntq_excelsior_engine.gemspec.
+gemspec
+
+gem "httparty"

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    custplace (0.0.6)
+      httparty (< 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    mini_mime (1.1.5)
+    multi_xml (0.6.0)
+
+PLATFORMS
+  arm64-darwin-21
+  ruby
+
+DEPENDENCIES
+  custplace!
+  httparty
+
+BUNDLED WITH
+   2.5.5

data/lib/custplace/answers.rb

@@ -0,0 +1,13 @@
+require 'custplace/base'
+require 'custplace/entities/review'
+
+module Custplace
+  class Reviews < Custplace::Base
+
+    def reply(review_id, message)
+      response = post("/answers", params: { message: message, message_id: review_id })
+      Custplace::Entities::Answer.new(response["data"])
+    end
+
+  end
+end

data/lib/custplace/base.rb

@@ -0,0 +1,49 @@
+require 'httparty'
+module Custplace
+  class Base
+    include HTTParty
+
+    base_uri 'https://apis.custplace.com/v3'
+
+    API_VERSION = '3.1.0'
+
+    attr_accessor :client
+
+    # Initialize a new Custplace::Api::Base
+    #
+    # @param client [Custplace::Client] the client to use for the api
+    # @return [Custplace::Api::Base]
+    def initialize(client)
+      @client = client
+    end
+
+    def default_headers
+      {
+        "Custplace-Version": API_VERSION,
+        "Authorization": "Bearer #{client.access_token}"
+      }
+    end
+
+    def get(path, params: {})
+      response = self.class.get("#{account_base_url}#{path}", query: params, headers: default_headers)
+      parsed_response = response.parsed_response
+      parsed_response
+    end
+
+    def post(path, params: {})
+      response = self.class.post("#{account_base_url}#{path}", body: params.to_json, headers: default_headers)
+      parsed_response = response.parsed_response
+      parsed_response
+    end
+
+  private
+
+    # Get the base url for the account
+    #
+    # @return [String] the base url for the account
+    def account_base_url
+      "/#{client.account_id}"
+    end
+
+  end
+end

data/lib/custplace/client.rb

@@ -0,0 +1,34 @@
+require 'custplace/stores'
+require 'custplace/reviews'
+require 'custplace/answers'
+
+module Custplace
+  class Client
+
+    attr_reader :account_id, :access_token
+
+    # Public: Initialize a new Custplace::Client
+    #
+    # @param account_id [String] the account id found in custplace account url
+    # @param access_token [String] the access token for the account found in the integration page on Custplace
+    # @param options [Hash] the options to initialize the client with
+    # @return [Custplace::Client]
+    def initialize(account_id, access_token, options = {})
+      @account_id = account_id.to_s
+      @access_token = access_token
+    end
+
+    def stores
+      @stores ||= Custplace::Stores.new(self)
+    end
+
+    def reviews
+      @reviews ||= Custplace::Reviews.new(self)
+    end
+
+    def answers
+      @answers ||= Custplace::Answers.new(self)
+    end
+
+  end
+end

data/lib/custplace/entities/answer.rb

@@ -0,0 +1,19 @@
+require 'custplace/meta_methods'
+# Describe the store entity to return in the store api
+module Custplace
+  module Entities
+    class Answer < Custplace::MetaMethods
+
+      object_attr_reader :id
+      object_attr_reader :message
+      object_attr_reader :is_official
+      object_attr_reader :is_private
+      object_attr_reader :source
+      object_attr_reader :author, Custplace::Entities::Author
+
+      object_attr_reader :created_at, Time
+      object_attr_reader :updated_at, Time
+
+    end
+  end
+end

data/lib/custplace/entities/author.rb

@@ -0,0 +1,16 @@
+require 'custplace/meta_methods'
+# Describe the store entity to return in the store api
+module Custplace
+  module Entities
+    class Author < Custplace::MetaMethods
+
+      object_attr_reader :id
+      object_attr_reader :firstname
+      object_attr_reader :lastname
+      object_attr_reader :fullname
+      object_attr_reader :email
+      object_attr_reader :username
+
+    end
+  end
+end

data/lib/custplace/entities/review.rb

@@ -0,0 +1,26 @@
+require 'custplace/meta_methods'
+require 'custplace/entities/author'
+require 'custplace/entities/answer'
+# Describe the store entity to return in the store api
+module Custplace
+  module Entities
+    class Review < Custplace::MetaMethods
+
+      object_attr_reader :id
+      object_attr_reader :source
+      object_attr_reader :type
+      object_attr_reader :rating_note
+      object_attr_reader :answers_count
+      object_attr_reader :shop, Custplace::Entities::Store, method_alias: :store
+      object_attr_reader :locale
+      object_attr_reader :subject
+      object_attr_reader :message
+      object_attr_reader :author, Custplace::Entities::Author
+      object_attr_reader :answers, [Custplace::Entities::Answer]
+
+      object_attr_reader :created_at, Time
+      object_attr_reader :updated_at, Time
+
+    end
+  end
+end

data/lib/custplace/entities/store.rb

@@ -0,0 +1,16 @@
+require 'custplace/meta_methods'
+# Describe the store entity to return in the store api
+module Custplace
+  module Entities
+    class Store < Custplace::MetaMethods
+
+      object_attr_reader :id
+      object_attr_reader :name
+      object_attr_reader :type
+      object_attr_reader :store_code
+      object_attr_reader :reviews_count
+      object_attr_reader :score
+
+    end
+  end
+end

data/lib/custplace/meta_methods.rb

@@ -0,0 +1,58 @@
+module Custplace
+  class MetaMethods
+    include Memoizable
+  
+    attr_reader :attrs, :keys
+  
+    def initialize(data)
+      @attrs = data.is_a?(Hash) ? data.with_indifferent_access : data
+    end
+  
+    class << self
+      def object_attr_reader(key1, klass=nil, **args)
+        if key1.is_a?(Array)
+          key1.each do |key|
+            define_attribute_method(key, klass, args)
+          end
+        else
+          define_attribute_method(key1, klass, args)
+        end
+      end
+  
+      # Dynamically define a method for an attribute
+      #
+      # @param key1 [Symbol], or [Array]
+      # @param klass [Symbol]
+      # @param method_alias [Symbol] - alias
+      # @param target_alias [Symbol] - key for this item in the target class
+      # @param include_keys [Symbol] - used in define_attribute_method not here
+      # @param extra_key [Symbol] - down an extra level. IE progression: { raids: [...] }
+      def define_attribute_method(key1, klass = nil, method_alias: key1, target_alias: nil, include_keys: nil, extra_key: nil)
+        define_method(method_alias) do ||
+          target = extra_key.nil? ? @attrs[key1] : @attrs[key1].nil? ? nil : @attrs[key1][extra_key]
+          if target.nil?
+            nil
+          else
+            if klass.nil?
+              target
+            else
+              if klass.is_a?(Array)
+                target.map do |t|
+                  klass.first.new(t)
+                end
+              else
+                klass.new(target)
+              end
+            end
+          end
+        end
+        begin
+          return memoize(method_alias)
+        rescue Exception => e
+          Appsignal.send_error(e)
+        end
+      end
+    end
+  
+  end
+end

data/lib/custplace/reviews.rb

@@ -0,0 +1,40 @@
+require 'custplace/base'
+require 'custplace/entities/review'
+
+module Custplace
+  class Reviews < Custplace::Base
+
+    # Get the list of all reviews
+    #
+    # @param params [Hash] the params to use for the request
+    # @return [Array<Custplace::Entities::Store>] the list of stores
+    def list(params: {})
+      page = 1
+      reviews = []
+      response = get("/messages", params: params.merge(page: page, per_page: 100 ))
+      data = response["data"]
+      reviews = reviews.concat(data.map { |review| Custplace::Entities::Review.new(review) })
+      pagination = response["links"]
+
+      while pagination["next"]
+        page += 1
+        response = get("/messages", params: params.merge(page: page))
+        data = response["data"]
+        reviews = reviews.concat(data.map { |review| Custplace::Entities::Review.new(review) })
+        pagination = response["links"]
+      end
+
+      reviews
+    end
+
+    # Retrieves the details of an existing review.
+    #
+    # @param review_id [String] the id of the review to retrieve
+    # @return [Custplace::Entities::Store] the store
+    def find(review_id)
+      response = get("/messages/#{review_id}")
+      Custplace::Entities::Review.new(response["data"])
+    end
+
+  end
+end

data/lib/custplace/stores.rb

@@ -0,0 +1,40 @@
+require 'custplace/base'
+require 'custplace/entities/store'
+
+module Custplace
+  class Stores < Custplace::Base
+
+    # Get the list of all active stores
+    #
+    # @param params [Hash] the params to use for the request
+    # @return [Array<Custplace::Entities::Store>] the list of stores
+    def list(params: {})
+      page = 1
+      stores = []
+      response = get("/shops", params: params.merge(page: page))
+      data = response["data"]
+      stores = stores.concat(data.map { |store| Custplace::Entities::Store.new(store) })
+      pagination = response["links"]
+
+      while pagination["next"]
+        page += 1
+        response = get("/shops", params: params.merge(page: page))
+        data = response["data"]
+        stores = stores.concat(data.map { |store| Custplace::Entities::Store.new(store) })
+        pagination = response["links"]
+      end
+
+      stores
+    end
+
+    # Retrieves the details of an existing store.
+    #
+    # @param store_id [String] the id of the store to retrieve
+    # @return [Custplace::Entities::Store] the store
+    def find(store_id)
+      response = get("/shops/#{store_id}")
+      Custplace::Entities::Store.new(response["data"])
+    end
+
+  end
+end

data/lib/custplace/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Custplace
+  VERSION = '0.0.6'
+end

data/lib/custplace.rb

@@ -1,4 +1,6 @@
+require_relative 'custplace/version'
 require 'custplace/client'
 
 module Custplace
+  class Error < StandardError; end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: custplace
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Qualimétrie
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2024-03-28 00:00:00.000000000 Z
 dependencies:
@@ -30,7 +30,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
 - lib/custplace.rb
+- lib/custplace/answers.rb
+- lib/custplace/base.rb
+- lib/custplace/client.rb
+- lib/custplace/entities/answer.rb
+- lib/custplace/entities/author.rb
+- lib/custplace/entities/review.rb
+- lib/custplace/entities/store.rb
+- lib/custplace/meta_methods.rb
+- lib/custplace/reviews.rb
+- lib/custplace/stores.rb
+- lib/custplace/version.rb
 homepage: https://rubygems.org/gems/custplace
 licenses:
 - MIT