pirsch_api 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e82d43aa436f9f1d2947ecf55d73e236bcaf002cc6a1b706d5e3cea589d6b69b
-  data.tar.gz: a5e777c6d97f42df2b332f28cd72530470b4a192ae8c3c70655deaa41bfd70d8
+  metadata.gz: 006765cdfc16afa484a20da5b5e7e507dc50a5fe41e7cf6a869199d9d3112241
+  data.tar.gz: adf718d65c7d1f74a0b3f48a2803b778dc15d58c0b2f38e7730dc387e7f076a0
 SHA512:
-  metadata.gz: 9ba33c184b234b4724f41dc1e3739bfe380ecb087e356fae99ca405ec1592dc2b0e1cfec607ffe8dc1631ddbb7c5a8f0ff312ff64f6262541302611034038bce
-  data.tar.gz: 2f10015e504aad54aa4abba5719147fc7946870bc533b9dc97f0c1e1dc3342f8e6a469ef317f35dd7a2a016f8e2cc70d98c3c954a6268a67de5f06f40ddfe2f7
+  metadata.gz: ec39210e5901821c896b82c6a0f551adbfc541bd007403f7ef91c8147abebc67e75408ce7d691b530226a7a118753c290f0903960e18aaafdab4f7be0ec17285
+  data.tar.gz: fe077953f1d9a7ca5b69a945688e37ae8d0dcffcd158ca4b46e0fca1940a38580bd8686599b322c027adfba5298e2b4b4dcfd4c773a7356927b65c0e27140134

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pirsch_api (0.0.5)
+    pirsch_api (0.1.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/pirsch_api/client.rb

@@ -2,16 +2,17 @@
 
 module PirschApi
   class Client
-    
-    BASE_URL = 'https://api.pirsch.io/api/v1'
+    BASE_URL = "https://api.pirsch.io/api/v1"
 
     def initialize(client_id:, client_secret:)
-      @client_id     = client_id.to_s
+      @client_id = client_id.to_s
       @client_secret = client_secret.to_s
     end
 
     def valid?
-      true if token rescue false
+      true if token
+    rescue
+      false
     end
 
     def token
@@ -22,48 +23,48 @@ module PirschApi
       DomainResource.new(client: self).run
     end
 
-    def visitors(filters: {}, domain:)
+    def visitors(domain:, filters: {})
       VisitorResource.new(client: self, filters: filters, domain: domain).run
     end
 
-    def pages(filters: {}, domain:)
+    def pages(domain:, filters: {})
       PageResource.new(client: self, filters: filters, domain: domain).run
     end
 
-    def referrers(filters: {}, domain:)
+    def referrers(domain:, filters: {})
       ReferrerResource.new(client: self, filters: filters, domain: domain).run
     end
 
-    def active(filters: {}, domain:)
+    def active(domain:, filters: {})
       ActiveResource.new(client: self, filters: filters, domain: domain).run
     end
 
-    def growth(filters: {}, domain:)
+    def growth(domain:, filters: {})
       GrowthResource.new(client: self, filters: filters, domain: domain).run
     end
 
-    def events(filters: {}, domain:)
+    def events(domain:, filters: {})
       EventResource.new(client: self, filters: filters, domain: domain).run
     end
 
-    def utm_source(filters: {}, domain:)
+    def utm_source(domain:, filters: {})
       UtmSourceResource.new(client: self, filters: filters, domain: domain).run
     end
 
-    def utm_medium(filters: {}, domain:)
+    def utm_medium(domain:, filters: {})
       UtmMediumResource.new(client: self, filters: filters, domain: domain).run
     end
 
-    def utm_campaign(filters: {}, domain:)
+    def utm_campaign(domain:, filters: {})
       UtmCampaignResource.new(client: self, filters: filters, domain: domain).run
     end
 
-    def duration_session(filters: {}, domain:)
+    def duration_session(domain:, filters: {})
       DurationSessionResource.new(client: self, filters: filters, domain: domain).run
     end
 
-    def duration_page(filters: {}, domain:)
+    def duration_page(domain:, filters: {})
       DurationPageResource.new(client: self, filters: filters, domain: domain).run
     end
   end
-end
+end

data/lib/pirsch_api/error.rb

@@ -1,4 +1,4 @@
 module PirschApi
   class Error < StandardError
   end
-end
+end

data/lib/pirsch_api/object.rb

@@ -16,4 +16,4 @@ module PirschApi
       end
     end
   end
-end
+end

data/lib/pirsch_api/objects/active.rb

@@ -1,4 +1,4 @@
 module PirschApi
   class Active < Object
   end
-end
+end

data/lib/pirsch_api/objects/domain.rb

@@ -4,4 +4,4 @@ module PirschApi
       id.to_s
     end
   end
-end
+end

data/lib/pirsch_api/objects/duration_page.rb

@@ -1,4 +1,4 @@
 module PirschApi
   class DurationPage < Object
   end
-end
+end

data/lib/pirsch_api/objects/duration_session.rb

@@ -1,4 +1,4 @@
 module PirschApi
   class DurationSession < Object
   end
-end
+end

data/lib/pirsch_api/objects/event.rb

@@ -1,4 +1,4 @@
 module PirschApi
   class Event < Object
   end
-end
+end

data/lib/pirsch_api/objects/growth.rb

@@ -1,4 +1,4 @@
 module PirschApi
   class Growth < Object
   end
-end
+end

data/lib/pirsch_api/objects/page.rb

@@ -1,4 +1,4 @@
 module PirschApi
   class Page < Object
   end
-end
+end

data/lib/pirsch_api/objects/referrer.rb

@@ -1,4 +1,4 @@
 module PirschApi
   class Referrer < Object
   end
-end
+end

data/lib/pirsch_api/objects/token.rb

@@ -1,4 +1,4 @@
 module PirschApi
   class Token < Object
   end
-end
+end

data/lib/pirsch_api/objects/utm_campaign.rb

@@ -1,4 +1,4 @@
 module PirschApi
   class UtmCampaign < Object
   end
-end
+end

data/lib/pirsch_api/objects/utm_medium.rb

@@ -1,4 +1,4 @@
 module PirschApi
   class UtmMedium < Object
   end
-end
+end

data/lib/pirsch_api/objects/utm_source.rb

@@ -1,4 +1,4 @@
 module PirschApi
   class UtmSource < Object
   end
-end
+end

data/lib/pirsch_api/objects/visitor.rb

@@ -1,4 +1,4 @@
 module PirschApi
   class Visitor < Object
   end
-end
+end

data/lib/pirsch_api/resources/base.rb

@@ -1,6 +1,5 @@
 module PirschApi
   class BaseResource
-
     attr_accessor :client, :filters, :domain
 
     def initialize(client:, domain: nil, filters: {})
@@ -19,7 +18,7 @@ module PirschApi
     end
 
     def errors
-      @errors[:client] = 'client is invalid' unless client.valid?
+      @errors[:client] = "client is invalid" unless client.valid?
       @errors
     end
 
@@ -29,24 +28,24 @@ module PirschApi
 
     def run
       raise PirschApi::Error.new errors unless valid?
-      
+
       if domain
         filters[:id] = domain.to_s
       end
 
       url = "#{PirschApi::Client::BASE_URL}/#{request_url}"
-      url << "?#{filters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join("&") }" if filters.any?
+      url << "?#{filters.to_a.map { |x| "#{x[0]}=#{CGI.escape(x[1])}" }.join("&")}" if filters.any?
 
       puts "[Pirsch API] run #{url}"
 
       uri = URI.parse url
 
       req = Net::HTTP::Get.new(uri.request_uri)
-      req.add_field('Authorization', "Bearer #{client.token.access_token}")
+      req.add_field("Authorization", "Bearer #{client.token.access_token}")
 
       http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true  
-      
+      http.use_ssl = true
+
       response = http.request(req)
       raise PirschApi::Error.new "Api request failed (#{response.body})" unless response.code == "200"
       raise PirschApi::Error.new "Api request returned nil (#{response.body})" if response.body.nil?
@@ -54,4 +53,4 @@ module PirschApi
       parse_response response.body
     end
   end
-end
+end

data/lib/pirsch_api/resources/domain.rb

@@ -5,7 +5,7 @@ module PirschApi
     end
 
     def parse_response(body)
-      JSON.parse(body).map{ |o| Domain.new o }
+      JSON.parse(body).map { |o| Domain.new o }
     end
   end
-end
+end

data/lib/pirsch_api/resources/statistics/active.rb

@@ -8,4 +8,4 @@ module PirschApi
       Active.new JSON.parse(body)
     end
   end
-end
+end

data/lib/pirsch_api/resources/statistics/duration_page.rb

@@ -3,9 +3,9 @@ module PirschApi
     def request_url
       "statistics/duration/page"
     end
-    
+
     def parse_response(body)
-      JSON.parse(body)&.map{ |o| DurationPage.new o }
+      JSON.parse(body)&.map { |o| DurationPage.new o }
     end
   end
-end
+end

data/lib/pirsch_api/resources/statistics/duration_session.rb

@@ -3,9 +3,9 @@ module PirschApi
     def request_url
       "statistics/duration/session"
     end
-    
+
     def parse_response(body)
-      JSON.parse(body)&.map{ |o| DurationSession.new o }
+      JSON.parse(body)&.map { |o| DurationSession.new o }
     end
   end
-end
+end

data/lib/pirsch_api/resources/statistics/event.rb

@@ -3,8 +3,9 @@ module PirschApi
     def request_url
       "statistics/events"
     end
+
     def parse_response(body)
-      JSON.parse(body)&.map{ |o| Event.new o }
+      JSON.parse(body)&.map { |o| Event.new o }
     end
   end
-end
+end

data/lib/pirsch_api/resources/statistics/growth.rb

@@ -8,4 +8,4 @@ module PirschApi
       Growth.new JSON.parse(body)
     end
   end
-end
+end

data/lib/pirsch_api/resources/statistics/page.rb

@@ -5,7 +5,7 @@ module PirschApi
     end
 
     def parse_response(body)
-      JSON.parse(body)&.map{ |o| Page.new o }
+      JSON.parse(body)&.map { |o| Page.new o }
     end
   end
-end
+end

data/lib/pirsch_api/resources/statistics/referrer.rb

@@ -5,7 +5,7 @@ module PirschApi
     end
 
     def parse_response(body)
-      JSON.parse(body)&.map{ |o| Referrer.new o }
+      JSON.parse(body)&.map { |o| Referrer.new o }
     end
   end
-end
+end

data/lib/pirsch_api/resources/statistics/utm_campaign.rb

@@ -3,9 +3,9 @@ module PirschApi
     def request_url
       "statistics/utm/campaign"
     end
-    
+
     def parse_response(body)
-      JSON.parse(body)&.map{ |o| UtmCampaign.new o }
+      JSON.parse(body)&.map { |o| UtmCampaign.new o }
     end
   end
-end
+end

data/lib/pirsch_api/resources/statistics/utm_medium.rb

@@ -3,9 +3,9 @@ module PirschApi
     def request_url
       "statistics/utm/medium"
     end
-    
+
     def parse_response(body)
-      JSON.parse(body)&.map{ |o| UtmMedium.new o }
+      JSON.parse(body)&.map { |o| UtmMedium.new o }
     end
   end
-end
+end

data/lib/pirsch_api/resources/statistics/utm_source.rb

@@ -3,9 +3,9 @@ module PirschApi
     def request_url
       "statistics/utm/source"
     end
-    
+
     def parse_response(body)
-      JSON.parse(body)&.map{ |o| UtmSource.new o }
+      JSON.parse(body)&.map { |o| UtmSource.new o }
     end
   end
-end
+end

data/lib/pirsch_api/resources/statistics/visitor.rb

@@ -5,7 +5,7 @@ module PirschApi
     end
 
     def parse_response(body)
-      JSON.parse(body)&.map{ |o| Visitor.new o }
+      JSON.parse(body)&.map { |o| Visitor.new o }
     end
   end
-end
+end

data/lib/pirsch_api/resources/token.rb

@@ -1,12 +1,10 @@
 module PirschApi
-  
   class TokenResource
-
     def initialize(client_id, client_secret)
-      @client_id     = client_id
+      @client_id = client_id
       @client_secret = client_secret
     end
-    
+
     def request_url
       "token"
     end
@@ -29,16 +27,16 @@ module PirschApi
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      
-      header = { 'Content-Type': 'text/json' }
+
+      header = {"Content-Type": "text/json"}
       request = Net::HTTP::Post.new(uri.request_uri, header)
       request.body = request_body
-      
+
       response = http.request(request)
 
       raise Error.new "Token request failed. (#{response.body})" unless response.code == "200"
-      
+
       parse_response(response.body)
     end
   end
-end
+end

data/lib/pirsch_api/version.rb

@@ -1,3 +1,3 @@
 module PirschApi
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/lib/pirsch_api.rb

@@ -1,9 +1,9 @@
-require 'json'
+require "json"
 require "net/http"
 require "uri"
 require "cgi"
 
-require 'pirsch_api/version'
+require "pirsch_api/version"
 
 module PirschApi
   autoload :Client, "pirsch_api/client"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pirsch_api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2023-06-14 00:00:00.000000000 Z
 dependencies: []
 description: A very humble wrapper for the API by Pirsch.io
 email:
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A simple Pirsch Analytics API wrapper for Rails