pirsch_api 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe170bae8684aadfe97a08ea60a306b3d04d049b993a463f957431479c5139b9
-  data.tar.gz: 303cf49a7ddc8a1e85cf5566e6302b461828769e87cf627355371deba5a9c8a4
+  metadata.gz: e82d43aa436f9f1d2947ecf55d73e236bcaf002cc6a1b706d5e3cea589d6b69b
+  data.tar.gz: a5e777c6d97f42df2b332f28cd72530470b4a192ae8c3c70655deaa41bfd70d8
 SHA512:
-  metadata.gz: d203d84c0edea9a28b7d919ef1a6ad1f2fa6696d58fec2dff3bfe69c26ad47891a4d733f7299694483415a21cb492e22b6ca4815b59e0bcbc0f608df12677480
-  data.tar.gz: eaf65a16668affd4db442b338a3eb63e612f8ac0430ee18ca89d879698aa74ca4bdd88b8b230a5dc955ab589c260bb7aeabb1980f66c69702036e2532196d930
+  metadata.gz: 9ba33c184b234b4724f41dc1e3739bfe380ecb087e356fae99ca405ec1592dc2b0e1cfec607ffe8dc1631ddbb7c5a8f0ff312ff64f6262541302611034038bce
+  data.tar.gz: 2f10015e504aad54aa4abba5719147fc7946870bc533b9dc97f0c1e1dc3342f8e6a469ef317f35dd7a2a016f8e2cc70d98c3c954a6268a67de5f06f40ddfe2f7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/Gemfile.lock

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

data/README.md

@@ -4,21 +4,80 @@ It's based on the [API guide](https://docs.pirsch.io/api-sdks/api/)
 
 ## Usage
 Add this gem to your Gemfile:
+
 ```rb
 gem 'pirsch_api'
 ```
-Then you need to initialize a Client with your `client_id` and the `client_secret`.
+
+Now you need to initialize a Client with your `client_id` and the `client_secret`.
+
 ```rb
-c = PirschApi::Client.new('<client_id>', '<client_secret>') 
+client = PirschApi::Client.new(client_id: '<client_id>', client_secret: '<client_secret>') 
 
 # Test if the credentials are valid
-c.valid?
+client.valid?
 => true
+```
+
+You will need a `Domain` as a parameter to all the following methods. This parameter could be either
+a `PirschApi::Domain` instance or a simple String containing the `id` of one domain.
+
+```rb
+# Get /domains
+client.domains
+=> [#<PirschApi::Domain id="0D3a...", user_id="0D3a...", hostname="pirsch.io", subdomain="pirsch", ... >]
+domain = client.domains.first
+```
+
+All the following methods receive a `domain` and an optional `filters` hash as a parameter. You can include any filter defined in the official documentation.
+
+```rb
+# Get /statistics/visitors
+client.visitors(domain: domain, filters: filters)
+
+# Get /statistics/active
+client.active(domain: domain, filters: filters)
 
-# Get a new Access Token
-c.token
+# Get /statistics/pages
+client.pages(domain: domain, filters: filters)
+
+# Get /statistics/referrers
+client.referrers(domain: domain, filters: filters)
+
+# Get /statistics/growth
+client.growth(domain: domain, filters: filters)
+
+# Get /statistics/events
+client.events(domain: domain, filters: filters)
+
+# Get /statistics/utm/source
+client.utm_source(domain: domain, filters: filters)
+
+# Get /statistics/utm/medium
+client.utm_medium(domain: domain, filters: filters)
+
+# Get /statistics/utm/campaign
+client.utm_campaign(domain: domain, filters: filters)
 ```
 
+## Examples
+```rb
+client.visitors(domain: domain)
+=> [#<PirschApi::Visitor day="2021-08-30T00:00:00Z", visitors=87, views=200, sessions=125, bounces=53, bounce_rate=0.6091954022988506>, #<PirschApi::Visitor day="2021-08-31T00:00:00Z", visitors=77, views=159, sessions=113, bounces=49, bounce_rate=0.6363636363636364>, #<PirschApi::Visitor day="2021-09-01T00:00:00Z", visitors=76, views=161, sessions=110, bounces=48, bounce_rate=0.631578947368421>, #<PirschApi::Visitor day="2021-09-02T00:00:00Z", visitors=79, views=152, sessions=130, bounces=52, bounce_rate=0.6582278481012658>, #<PirschApi::Visitor day="2021-09-03T00:00:00Z", visitors=53, views=109, sessions=68, bounces=26, bounce_rate=0.49056603773584906>, #<PirschApi::Visitor day="2021-09-04T00:00:00Z", visitors=54, views=126, sessions=71, bounces=31, bounce_rate=0.5740740740740741>, #<PirschApi::Visitor day="2021-09-05T00:00:00Z", visitors=116, views=202, sessions=131, bounces=84, bounce_rate=0.7241379310344828>, #<PirschApi::Visitor day="2021-09-06T00:00:00Z", visitors=1, views=1, sessions=1, bounces=1, bounce_rate=1>]
+
+client.visitors(domain: domain, filters: { from: '2021-09-01' })
+=> [#<PirschApi::Visitor day="2021-09-01T00:00:00Z", visitors=76, views=161, sessions=110, bounces=48, bounce_rate=0.631578947368421>, #<PirschApi::Visitor day="2021-09-02T00:00:00Z", visitors=79, views=152, sessions=130, bounces=52, bounce_rate=0.6582278481012658>, #<PirschApi::Visitor day="2021-09-03T00:00:00Z", visitors=53, views=109, sessions=68, bounces=26, bounce_rate=0.49056603773584906>, #<PirschApi::Visitor day="2021-09-04T00:00:00Z", visitors=54, views=126, sessions=71, bounces=31, bounce_rate=0.5740740740740741>, #<PirschApi::Visitor day="2021-09-05T00:00:00Z", visitors=116, views=202, sessions=131, bounces=84, bounce_rate=0.7241379310344828>, #<PirschApi::Visitor day="2021-09-06T00:00:00Z", visitors=1, views=1, sessions=1, bounces=1, bounce_rate=1>]
+
+client.visitors(domain: domain, filters: { from: '2021-09-01' }).first.day
+=> "2021-09-01T00:00:00Z"
+
+# Get /statistics/active
+client.active(domain: domain)
+=> #<PirschApi::Active stats=nil, visitors=0>
+
+client.active(domain: domain).visitors
+=> 0
+```
 
 ## Development
 

data/lib/pirsch_api/client.rb

@@ -1,28 +1,69 @@
 # frozen_string_literal: true
 
-require 'pirsch_api/token'
-
-require 'json'
-require "net/http"
-require "uri"
-require "cgi"
-
 module PirschApi
   class Client
     
-    BASE_URL = 'https://api.pirsch.io'
+    BASE_URL = 'https://api.pirsch.io/api/v1'
 
-    def initialize(client_id, client_secret)
+    def initialize(client_id:, client_secret:)
       @client_id     = client_id.to_s
       @client_secret = client_secret.to_s
     end
 
+    def valid?
+      true if token rescue false
+    end
+
     def token
-      @token ||= PirschApi::Token.new(@client_id, @client_secret).run
+      @token ||= TokenResource.new(@client_id, @client_secret).run
     end
 
-    def valid?
-      true if token rescue false
+    def domains
+      DomainResource.new(client: self).run
+    end
+
+    def visitors(filters: {}, domain:)
+      VisitorResource.new(client: self, filters: filters, domain: domain).run
+    end
+
+    def pages(filters: {}, domain:)
+      PageResource.new(client: self, filters: filters, domain: domain).run
+    end
+
+    def referrers(filters: {}, domain:)
+      ReferrerResource.new(client: self, filters: filters, domain: domain).run
+    end
+
+    def active(filters: {}, domain:)
+      ActiveResource.new(client: self, filters: filters, domain: domain).run
+    end
+
+    def growth(filters: {}, domain:)
+      GrowthResource.new(client: self, filters: filters, domain: domain).run
+    end
+
+    def events(filters: {}, domain:)
+      EventResource.new(client: self, filters: filters, domain: domain).run
+    end
+
+    def utm_source(filters: {}, domain:)
+      UtmSourceResource.new(client: self, filters: filters, domain: domain).run
+    end
+
+    def utm_medium(filters: {}, domain:)
+      UtmMediumResource.new(client: self, filters: filters, domain: domain).run
+    end
+
+    def utm_campaign(filters: {}, domain:)
+      UtmCampaignResource.new(client: self, filters: filters, domain: domain).run
+    end
+
+    def duration_session(filters: {}, domain:)
+      DurationSessionResource.new(client: self, filters: filters, domain: domain).run
+    end
+
+    def duration_page(filters: {}, domain:)
+      DurationPageResource.new(client: self, filters: filters, domain: domain).run
     end
   end
 end

data/lib/pirsch_api/error.rb

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

data/lib/pirsch_api/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module PirschApi
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/pirsch_api/objects/active.rb

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

data/lib/pirsch_api/objects/domain.rb

@@ -0,0 +1,7 @@
+module PirschApi
+  class Domain < Object
+    def to_s
+      id.to_s
+    end
+  end
+end

data/lib/pirsch_api/objects/duration_page.rb

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

data/lib/pirsch_api/objects/duration_session.rb

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

data/lib/pirsch_api/objects/event.rb

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

data/lib/pirsch_api/objects/growth.rb

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

data/lib/pirsch_api/objects/page.rb

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

data/lib/pirsch_api/objects/referrer.rb

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

data/lib/pirsch_api/objects/token.rb

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

data/lib/pirsch_api/objects/utm_campaign.rb

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

data/lib/pirsch_api/objects/utm_medium.rb

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

data/lib/pirsch_api/objects/utm_source.rb

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

data/lib/pirsch_api/objects/visitor.rb

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

data/lib/pirsch_api/resources/base.rb

@@ -0,0 +1,57 @@
+module PirschApi
+  class BaseResource
+
+    attr_accessor :client, :filters, :domain
+
+    def initialize(client:, domain: nil, filters: {})
+      @client = client
+      @filters = filters
+      @domain = domain
+      @errors = []
+    end
+
+    def request_url
+      raise NotImplementedError
+    end
+
+    def parse_response(body)
+      raise NotImplementedError
+    end
+
+    def errors
+      @errors[:client] = 'client is invalid' unless client.valid?
+      @errors
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    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?
+
+      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}")
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      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?
+
+      parse_response response.body
+    end
+  end
+end

data/lib/pirsch_api/resources/domain.rb

@@ -0,0 +1,11 @@
+module PirschApi
+  class DomainResource < BaseResource
+    def request_url
+      "domain"
+    end
+
+    def parse_response(body)
+      JSON.parse(body).map{ |o| Domain.new o }
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module PirschApi
+  class ActiveResource < BaseResource
+    def request_url
+      "statistics/active"
+    end
+
+    def parse_response(body)
+      Active.new JSON.parse(body)
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module PirschApi
+  class DurationPageResource < BaseResource
+    def request_url
+      "statistics/duration/page"
+    end
+    
+    def parse_response(body)
+      JSON.parse(body)&.map{ |o| DurationPage.new o }
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module PirschApi
+  class DurationSessionResource < BaseResource
+    def request_url
+      "statistics/duration/session"
+    end
+    
+    def parse_response(body)
+      JSON.parse(body)&.map{ |o| DurationSession.new o }
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module PirschApi
+  class EventResource < BaseResource
+    def request_url
+      "statistics/events"
+    end
+    def parse_response(body)
+      JSON.parse(body)&.map{ |o| Event.new o }
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module PirschApi
+  class GrowthResource < BaseResource
+    def request_url
+      "statistics/growth"
+    end
+
+    def parse_response(body)
+      Growth.new JSON.parse(body)
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module PirschApi
+  class PageResource < BaseResource
+    def request_url
+      "statistics/page"
+    end
+
+    def parse_response(body)
+      JSON.parse(body)&.map{ |o| Page.new o }
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module PirschApi
+  class ReferrerResource < BaseResource
+    def request_url
+      "statistics/referrer"
+    end
+
+    def parse_response(body)
+      JSON.parse(body)&.map{ |o| Referrer.new o }
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module PirschApi
+  class UtmCampaignResource < BaseResource
+    def request_url
+      "statistics/utm/campaign"
+    end
+    
+    def parse_response(body)
+      JSON.parse(body)&.map{ |o| UtmCampaign.new o }
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module PirschApi
+  class UtmMediumResource < BaseResource
+    def request_url
+      "statistics/utm/medium"
+    end
+    
+    def parse_response(body)
+      JSON.parse(body)&.map{ |o| UtmMedium.new o }
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module PirschApi
+  class UtmSourceResource < BaseResource
+    def request_url
+      "statistics/utm/source"
+    end
+    
+    def parse_response(body)
+      JSON.parse(body)&.map{ |o| UtmSource.new o }
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module PirschApi
+  class VisitorResource < BaseResource
+    def request_url
+      "statistics/visitor"
+    end
+
+    def parse_response(body)
+      JSON.parse(body)&.map{ |o| Visitor.new o }
+    end
+  end
+end

data/lib/pirsch_api/{token.rb → resources/token.rb}

@@ -1,6 +1,6 @@
 module PirschApi
   
-  class Token
+  class TokenResource
 
     def initialize(client_id, client_secret)
       @client_id     = client_id
@@ -8,7 +8,7 @@ module PirschApi
     end
     
     def request_url
-      "https://api.pirsch.io/api/v1/token"
+      "token"
     end
 
     def request_body
@@ -19,12 +19,13 @@ module PirschApi
     end
 
     def parse_response(body)
-      JSON.parse(body)['access_token']
+      puts "[Pirsch API] Token received"
+      Token.new JSON.parse(body)
     end
 
     def run
-      uri = URI.parse request_url
-      
+      uri = URI.parse "#{PirschApi::Client::BASE_URL}/#{request_url}"
+      puts "[Pirsch API] Requesting Token..."
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
@@ -34,7 +35,8 @@ module PirschApi
       request.body = request_body
       
       response = http.request(request)
-      raise PirschApi::Error.new "Token request failed. (#{response.body})" unless response.code == "200"
+
+      raise Error.new "Token request failed. (#{response.body})" unless response.code == "200"
       
       parse_response(response.body)
     end

data/lib/pirsch_api/version.rb

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

data/lib/pirsch_api.rb

@@ -1,6 +1,41 @@
+require 'json'
+require "net/http"
+require "uri"
+require "cgi"
+
 require 'pirsch_api/version'
-require 'pirsch_api/client'
 
 module PirschApi
-  class Error < StandardError; end
+  autoload :Client, "pirsch_api/client"
+  autoload :Error, "pirsch_api/error"
+
+  autoload :BaseResource, "pirsch_api/resources/base"
+  autoload :TokenResource, "pirsch_api/resources/token"
+  autoload :DomainResource, "pirsch_api/resources/domain"
+  autoload :VisitorResource, "pirsch_api/resources/statistics/visitor"
+  autoload :PageResource, "pirsch_api/resources/statistics/page"
+  autoload :ReferrerResource, "pirsch_api/resources/statistics/referrer"
+  autoload :ActiveResource, "pirsch_api/resources/statistics/active"
+  autoload :GrowthResource, "pirsch_api/resources/statistics/growth"
+  autoload :EventResource, "pirsch_api/resources/statistics/event"
+  autoload :UtmSourceResource, "pirsch_api/resources/statistics/utm_source"
+  autoload :UtmCampaignResource, "pirsch_api/resources/statistics/utm_campaign"
+  autoload :UtmMediumResource, "pirsch_api/resources/statistics/utm_medium"
+  autoload :DurationSessionResource, "pirsch_api/resources/statistics/duration_session"
+  autoload :DurationPageResource, "pirsch_api/resources/statistics/duration_page"
+
+  autoload :Object, "pirsch_api/object"
+  autoload :Token, "pirsch_api/objects/token"
+  autoload :Domain, "pirsch_api/objects/domain"
+  autoload :Visitor, "pirsch_api/objects/visitor"
+  autoload :Page, "pirsch_api/objects/page"
+  autoload :Referrer, "pirsch_api/objects/referrer"
+  autoload :Active, "pirsch_api/objects/active"
+  autoload :Growth, "pirsch_api/objects/growth"
+  autoload :Event, "pirsch_api/objects/event"
+  autoload :UtmSource, "pirsch_api/objects/utm_source"
+  autoload :UtmCampaign, "pirsch_api/objects/utm_campaign"
+  autoload :UtmMedium, "pirsch_api/objects/utm_medium"
+  autoload :DurationSession, "pirsch_api/objects/duration_session"
+  autoload :DurationPage, "pirsch_api/objects/duration_page"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pirsch_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-04 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies: []
 description: A very humble wrapper for the API by Pirsch.io
 email:
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -27,12 +28,37 @@ files:
 - bin/setup
 - lib/pirsch_api.rb
 - lib/pirsch_api/client.rb
-- lib/pirsch_api/token.rb
+- lib/pirsch_api/error.rb
+- lib/pirsch_api/object.rb
+- lib/pirsch_api/objects/active.rb
+- lib/pirsch_api/objects/domain.rb
+- lib/pirsch_api/objects/duration_page.rb
+- lib/pirsch_api/objects/duration_session.rb
+- lib/pirsch_api/objects/event.rb
+- lib/pirsch_api/objects/growth.rb
+- lib/pirsch_api/objects/page.rb
+- lib/pirsch_api/objects/referrer.rb
+- lib/pirsch_api/objects/token.rb
+- lib/pirsch_api/objects/utm_campaign.rb
+- lib/pirsch_api/objects/utm_medium.rb
+- lib/pirsch_api/objects/utm_source.rb
+- lib/pirsch_api/objects/visitor.rb
+- lib/pirsch_api/resources/base.rb
+- lib/pirsch_api/resources/domain.rb
+- lib/pirsch_api/resources/statistics/active.rb
+- lib/pirsch_api/resources/statistics/duration_page.rb
+- lib/pirsch_api/resources/statistics/duration_session.rb
+- lib/pirsch_api/resources/statistics/event.rb
+- lib/pirsch_api/resources/statistics/growth.rb
+- lib/pirsch_api/resources/statistics/page.rb
+- lib/pirsch_api/resources/statistics/referrer.rb
+- lib/pirsch_api/resources/statistics/utm_campaign.rb
+- lib/pirsch_api/resources/statistics/utm_medium.rb
+- lib/pirsch_api/resources/statistics/utm_source.rb
+- lib/pirsch_api/resources/statistics/visitor.rb
+- lib/pirsch_api/resources/token.rb
 - lib/pirsch_api/version.rb
 - pirsch_api.gemspec
-- pkg/plausible_api-0.1.0.gem
-- pkg/plausible_api-0.1.7.gem
-- pkg/plausible_api-0.1.8.gem
 homepage: https://github.com/dailytics/pirsch_api
 licenses:
 - MIT