fastlane-plugin-appstore_reviews 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9cbf24842f863d44fea86c9959cd710498736439eafdc5f6a72ae51ef246efb1
+  data.tar.gz: 1e856cefbc69c99f3ae3d432ce00463e26b3a2d9ee52e2461a56d0106282bba8
+SHA512:
+  metadata.gz: df8615504b535e182e680f42a12cf06dcd9b53dd2cc61c30ebac2eb8a9acd23e80ed37a4e8b2d6213e3380b136a2c6dc022f76479c11197c99cb0deaf5ac6f2f
+  data.tar.gz: 12c39a50cc491a29675252e0a305ef38aee9dfa4f509f9053b07cfa9c2aff539e72b04ad39f8aad43f0eddbd908539a0e6cb9f52ba57b548e50cc64ba49a3145

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mirsad Arslanovic <mirsad.arslanovic@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# appstore_reviews plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-appstore_reviews)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-appstore_reviews`, add it to your project by running:
+
+```bash
+fastlane add_plugin appstore_reviews
+```
+
+## About appstore_reviews
+
+The appstore_reviews plugin allows you to conveniently retrieve customer reviews for your iOS app from the App Store. This plugin utilizes the App Center API key and app ID to fetch reviews, providing an easy and automated way to monitor and respond to user feedback.
+
+## Usage
+
+To use the appstore_reviews plugin, add one of the following code snippets to your Fastfile, depending on your preferred configuration method:
+
+### Example 1: Using base64 key content
+
+```bash
+reviews = appstore_reviews(
+    key_id: ENV["ASCAPI_KEY_ID"],
+    issuer_id: ENV["ASCAPI_ISSUER_ID"],
+    key_content: ENV["ASCAPI_KEY_CONTENT"],
+    is_key_content_base64: true,
+    duration: 1200,
+    app_id: ENV["APP_ID"],
+    time_frame: "All"
+)
+```
+
+Also, check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/appstore_reviews/actions/appstore_reviews_action.rb

@@ -0,0 +1,129 @@
+require 'fastlane/action'
+require_relative '../helper/appstore_reviews_helper'
+require 'spaceship'
+
+module Fastlane
+  module Actions
+    class AppstoreReviewsAction < Action
+      def self.run(params)
+        key_id = params[:key_id]
+        issuer_id = params[:issuer_id]
+        key_content = params[:key_content]
+        is_key_content_base64 = params[:is_key_content_base64]
+        key_filepath = params[:key_filepath]
+        duration = params[:duration]
+        key = params[:key]
+        app_id = params[:app_id]
+        time_frame = params[:time_frame]
+
+        if key_content.nil? && key.nil? && key_filepath.nil? && key.nil?
+          UI.user_error!(":key_content or :key_filepath or :key is required")
+        end
+
+        if key
+          token = Helper::AppstoreReviewsHelper.generateToken(key: key)
+        elsif key_content
+          key = other_action.app_store_connect_api_key(key_id: key_id,
+                                                       issuer_id: issuer_id,
+                                                       key_content: key_content,
+                                                       is_key_content_base64: is_key_content_base64,
+                                                       duration: duration,
+                                                       in_house: false)
+          token = Helper::AppstoreReviewsHelper.generateToken(key: key)
+        elsif key_filepath
+          key = other_action.app_store_connect_api_key(key_id: key_id,
+                                                       issuer_id: issuer_id,
+                                                       key_filepath: key_filepath,
+                                                       duration: duration,
+                                                       in_house: false)
+          token = Helper::AppstoreReviewsHelper.generateToken(key: key)
+        else
+          UI.user_error!(":key_content or :key_filepath or :key is required")
+        end
+
+        return Helper::AppstoreReviewsHelper.getReviews(token: token, app_id: app_id, time_frame: time_frame)
+      end
+
+      def self.description
+        "Plugin to retrieve customer reviews for the app"
+      end
+
+      def self.authors
+        ["Mirsad Arslanovic"]
+      end
+
+      def self.return_value
+        "Array of review objects"
+      end
+
+      def self.details
+        # Optional:
+        "Plugin to retrieve customer reviews for the app"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :key, 
+                                       type: Hash,
+                                       optional: true,
+                                       conflicting_options: [:key_id, :issuer_id, :key_filepath, :key_content, :is_key_content_base64, :duration],
+                                       description: "Spaceship::ConnectAPI.Token type"),
+          FastlaneCore::ConfigItem.new(key: :key_id, 
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:key],
+                                       description: "The key ID"),
+          FastlaneCore::ConfigItem.new(key: :issuer_id, 
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:key],
+                                       description: "The issuer ID "),
+          FastlaneCore::ConfigItem.new(key: :key_filepath,
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:key, :key_content],
+                                       description: "The path to the key p8 file"),
+          FastlaneCore::ConfigItem.new(key: :key_content,
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: [:key, :key_filepath],
+                                       description: "The content of the key p8 file"),
+          FastlaneCore::ConfigItem.new(key: :is_key_content_base64,
+                                       type: Boolean,
+                                       optional: true,
+                                       conflicting_options: [:key],
+                                       description: "Whether :key_content is Base64 encoded or not false"),
+          FastlaneCore::ConfigItem.new(key: :duration,
+                                       optional: true,
+                                       type: Integer,
+                                       default_value: Spaceship::ConnectAPI::Token::DEFAULT_TOKEN_DURATION,
+                                       conflicting_options: [:key],
+                                       description: "The token session duration"),
+          FastlaneCore::ConfigItem.new(key: :app_id,
+                                       type: String,
+                                       optional: false,
+                                       description: "ID that uniquely identifies the app on appstore"),
+          FastlaneCore::ConfigItem.new(key: :time_frame,
+                                       description: "Time frame for the action (Today, Week, Month, Year)",
+                                       optional: false,
+                                       type: String,
+                                       default_value: 'Today',
+                                       verify_block: proc do |value|
+                                         valid_values = ['Today', 'Week', 'Month', 'Year', 'All']
+                                         unless valid_values.include?(value)
+                                           UI.user_error!("Invalid value for time_frame: #{value}. Valid values are #{valid_values.join(', ')}")
+                                         end
+                                       end)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/appstore_reviews/helper/appstore_reviews_helper.rb

@@ -0,0 +1,90 @@
+require 'fastlane_core/ui/ui'
+require 'spaceship'
+require 'net/http'
+require 'uri'
+require 'json'
+require_relative "../models/response.rb"
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class AppstoreReviewsHelper
+      def self.show_message
+        UI.message("Hello from the appstore_reviews plugin helper!")
+      end
+
+      def self.generateToken(params)
+        key = params[:key]
+        return Spaceship::ConnectAPI::Token.create(**key)
+      end
+
+      def self.getReviews(params, url=nil, reviews = [])
+        token = params[:token]
+        app_id = params[:app_id]
+        time_frame = params[:time_frame]
+
+        reviews_url = url
+        if url.nil?
+          reviews_url = "https://api.appstoreconnect.apple.com/v1/apps/#{app_id}/customerReviews?sort=-createdDate&limit=200"
+        end
+        puts "I am here"
+        response = self.makeAPIrequest(reviews_url, token)
+        parsed_json = JSON.parse(response)
+        parsed_response = AppstoreReviews::Response.new(parsed_json)
+
+        last_review = parsed_response.data.last
+        last_review_on_page_date = last_review.attributes.created_date
+        reviews.concat(parsed_response.data)
+
+        if self.should_call_more_pages(time_frame, last_review_on_page_date) && !parsed_response.links.next_link.nil?
+          self.getReviews(params, parsed_response.links.next_link, reviews)
+        end
+
+        return reviews
+      end
+
+      def self.should_call_more_pages(time_frame, last_review_date) 
+        case time_frame
+        when 'Today'
+          return last_review_date == Date.today
+        when 'Week'
+          return last_review_date >= Date.today - 7 && last_review_date <= Date.today
+        when 'Month'
+          return last_review_date >= Date.today - 30 && last_review_date <= Date.today
+        when 'Year'
+          return last_review_date >= Date.today - 365 && last_review_date <= Date.today
+        else
+          return true
+        end
+      end
+
+      def self.makeAPIrequest(url, token)
+        uri = URI(url)
+        request = Net::HTTP::Get.new(uri)
+
+        if token.expired?
+          UI.message("App Store Connect API token expired at #{token.expiration}... refreshing")
+          token.refresh!
+        end
+
+        request['Authorization'] = "Bearer #{token.text}"
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+          http.request(request)
+        end
+
+        case response
+        when Net::HTTPSuccess then
+          return response.body
+        else
+          UI.user_error!("AppstoreConnect API Request finished with error code: #{response.code}")
+        end
+      end
+
+      def self.getTimeFrame
+          return ['Today', 'Week', 'Month', 'Year']
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/appstore_reviews/models/customer_review.rb

@@ -0,0 +1,21 @@
+require_relative "customer_review.rb"
+require_relative "review_attributes.rb"
+require_relative "review_relationships.rb"
+require_relative "links.rb"
+require_relative "meta.rb"
+
+module Fastlane
+    module AppstoreReviews
+      class CustomerReview
+        attr_accessor :type, :id, :attributes, :relationships, :links
+
+        def initialize(json)
+          @type = json['type']
+          @id = json['id']
+          @attributes = ReviewAttributes.new(json['attributes'])
+          @relationships = ReviewRelationships.new(json['relationships'])
+          @links = Links.new(json['links'])
+        end
+      end
+    end
+  end

data/lib/fastlane/plugin/appstore_reviews/models/links.rb

@@ -0,0 +1,13 @@
+module Fastlane
+    module AppstoreReviews
+      class Links
+        attr_accessor :self_link, :related, :next_link
+
+        def initialize(json)
+          @self_link = json['self']
+          @related = json['related'] || nil
+          @next_link = json['next'] || nil
+        end
+      end
+    end
+  end

data/lib/fastlane/plugin/appstore_reviews/models/meta.rb

@@ -0,0 +1,13 @@
+require_relative "paging.rb"
+
+module Fastlane
+    module AppstoreReviews
+      class Meta
+        attr_accessor :paging
+
+        def initialize(json)
+          @paging = Paging.new(json['paging'])
+        end
+      end
+    end
+  end

data/lib/fastlane/plugin/appstore_reviews/models/paging.rb

@@ -0,0 +1,12 @@
+module Fastlane
+    module AppstoreReviews
+      class Paging
+        attr_accessor :total, :limit
+      
+        def initialize(json)
+          @total = json['total']
+          @limit = json['limit']
+        end
+      end
+    end
+  end

data/lib/fastlane/plugin/appstore_reviews/models/response.rb

@@ -0,0 +1,17 @@
+require_relative "customer_review.rb"
+require_relative "links.rb"
+require_relative "meta.rb"
+
+module Fastlane
+    module AppstoreReviews
+      class Response
+        attr_accessor :data, :links, :meta
+
+        def initialize(json)
+            @data = json['data'].map { |item| CustomerReview.new(item) }
+            @links = Links.new(json['links'])
+            @meta = Meta.new(json['meta'])
+          end
+      end
+    end
+  end

data/lib/fastlane/plugin/appstore_reviews/models/review_attributes.rb

@@ -0,0 +1,18 @@
+require 'date'
+
+module Fastlane
+    module AppstoreReviews
+      class ReviewAttributes
+        attr_accessor :rating, :title, :body, :reviewer_nickname, :created_date, :territory
+
+        def initialize(json)
+          @rating = json['rating']
+          @title = json['title']
+          @body = json['body']
+          @reviewer_nickname = json['reviewerNickname']
+          @created_date = DateTime.parse(json['createdDate'])
+          @territory = json['territory']
+        end
+      end
+    end
+end

data/lib/fastlane/plugin/appstore_reviews/models/review_relationships.rb

@@ -0,0 +1,13 @@
+require_relative "links.rb"
+module Fastlane
+    module AppstoreReviews
+      class ReviewRelationships
+        attr_accessor :links
+
+        def initialize(json)
+          response = json['response']
+          @links = Links.new(response)
+        end
+      end
+    end
+end

data/lib/fastlane/plugin/appstore_reviews/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module AppstoreReviews
+    VERSION = "1.0.0"
+  end
+end

data/lib/fastlane/plugin/appstore_reviews.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/appstore_reviews/version'
+
+module Fastlane
+  module AppstoreReviews
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::AppstoreReviews.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-appstore_reviews
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mirsad Arslanovic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.216.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.216.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.50.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.50.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: mirsad.arslanovic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/appstore_reviews.rb
+- lib/fastlane/plugin/appstore_reviews/actions/appstore_reviews_action.rb
+- lib/fastlane/plugin/appstore_reviews/helper/appstore_reviews_helper.rb
+- lib/fastlane/plugin/appstore_reviews/models/customer_review.rb
+- lib/fastlane/plugin/appstore_reviews/models/links.rb
+- lib/fastlane/plugin/appstore_reviews/models/meta.rb
+- lib/fastlane/plugin/appstore_reviews/models/paging.rb
+- lib/fastlane/plugin/appstore_reviews/models/response.rb
+- lib/fastlane/plugin/appstore_reviews/models/review_attributes.rb
+- lib/fastlane/plugin/appstore_reviews/models/review_relationships.rb
+- lib/fastlane/plugin/appstore_reviews/version.rb
+homepage: https://github.com/micho233/fastlane-plugin-appstore_reviews
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Plugin to retrieve customer reviews for the app
+test_files: []