app_manager 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9e83adb4c7828d26d8c6479837f58ea9e168726669c7a1d68f21e717a7802a4
-  data.tar.gz: 2d8f6811b2c09d80d268289b7e1b745583d1cec54b7bd7e9384544d3fa516caf
+  metadata.gz: 5d1ca5e305b62425f916bcb20e5677a2bc0be1e4b16f2d68879dcce443da5ffe
+  data.tar.gz: 1d174e5fbd19029a498c539ae908089dfcab7dea8b4d2f43d8e3bf48b9b354ca
 SHA512:
-  metadata.gz: fdf9b28f822093de96a8dd4f4324e1dd10c543a6667f9b76cc959ebe3ca2e65736b37388db7c400f3b08b441637c97ec39497001e32e597e073f85545319491b
-  data.tar.gz: 44d81124d5e88947f08648381705a309d86b8f789c450760c2f589ae585f63ac4dd02aaf9e640eafd585acfe8bc74ca59d8a6c86df346ead925de06854736df4
+  metadata.gz: 1b846e8b38a8fcb8301715c137f23e875828195c9b73bca8e1bbb814cf66fee9565690a296465757955d267fc290f574ba3434a63449657444c52144e0ad7c31
+  data.tar.gz: 00cdb184943ace69f37c5e166950791e193c67e071a88692a7b81d45de79a5d648ee2c70887c5f3cc1eea1d2ec5df82a7632aa9ae241c7f518c7f8ef52f31abe

data/Gemfile.lock

@@ -1,9 +1,11 @@
 PATH
   remote: .
   specs:
-    app_manager (0.1.2)
+    app_manager (1.0.0)
       httparty
+      kaminari (>= 0.16.3)
       rails (>= 5.2.0)
+      sqlite3 (~> 1.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -94,6 +96,18 @@ GEM
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     io-wait (0.2.1)
+    kaminari (1.2.2)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.2)
+      kaminari-activerecord (= 1.2.2)
+      kaminari-core (= 1.2.2)
+    kaminari-actionview (1.2.2)
+      actionview
+      kaminari-core (= 1.2.2)
+    kaminari-activerecord (1.2.2)
+      activerecord
+      kaminari-core (= 1.2.2)
+    kaminari-core (1.2.2)
     loofah (2.15.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -178,6 +192,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
+    sqlite3 (1.3.13)
     strscan (3.0.1)
     thor (1.2.1)
     timeout (0.2.0)

data/README.md

@@ -18,17 +18,126 @@ Step 2) Execute following in terminal:
     rails g app_manager:install
 
 
- this install command will mount routes in your rails route.
+ this install command will mount routes in your rails route and will create a config file at ```config/initializers/app_manager.rb```
 
+```
+AppManager.configure do |config|
+  config.enable_caching = false  # Optional, True to enable app-manager api response caching, default is enabled from gem
+  config.expires_in = 1.days  # Optional, Example: 30.seconds, 5.minutes or 2.days  Default caching is for 1.days from gem 
+  config.app_url = '' # App URL like https://volumediscount.hulkapps.dev/ or #https://5044-2409-4052-209a-69da-9d7-925a-9418-a9c3.ngrok.io
+  config.shopify_api_key = '' # Shopify api key of app
+  config.shopify_api_version = ''  # Must be 2022-04 or latest
+  config.shopify_table_name = 'shops'  #  Table name which is generated by shopify mostly it is 'shops'
+  config.shopify_domain_field = 'shopify_domain' #shopify domain field
+  config.plan_id_or_name_field = 'plan_id'
+  config.field_names = {
+        'name' => 'shopify_domain', # demo-rahul-tiwari.myshopify.com
+        'shopify_email' => 'email', # rahul.t@hulkapps.com
+        'shopify_token' => 'shopify_token',
+        'shopify_plan' => 'plan_name', # partner_test
+        'plan_id' => 'plan_id', # 1. t
+        'created_at' => 'created_at', # 2022-04-15 10:43:05
+        'trial_activated_at' => 'trial_activated_at' # field name that stores trial start/activated date
+    }
+  config.plan_features =  [
+    {
+	  	"uuid" => "b48a3a6c-c1fb-11ec-9d64-0242ac120002",
+	  	"name" => "Features 1",
+	  	"slug" => "feature-1",
+	  	"description" => "Feature Description",
+	  	"value_type" => "integer",
+	  	"format" => "count",
+	  	"display_order" => 1
+	},
+	{
+		"uuid" => "9f18f95a-bfaf-11ec-9d64-0242ac120002",
+		"name" => "Features 2",
+		"slug" => "feature-2",
+		"description" => "Feature Description",
+		"value_type" => "boolean",
+		"format" => "percentage",
+	  	"display_order" => 2
+	},
+	{
+		"uuid" => "9f190a26-bfaf-11ec-9d64-0242ac120002",
+		"name" => "Features 3",
+		"slug" => "feature-3",
+		"description" => "Feature Description",
+		"value_type" => "string",
+	  	"format" => "string",
+	  	"display_order" => 3
+	},
+	{
+		"uuid" => "9f191340-bfaf-11ec-9d64-0242ac12000",
+		"name" => "Features 4",
+		"slug" => "feature-4",
+		"description" => "Feature Description",
+		"value_type" => "array",
+		"values" => [
+			"val 1",
+			"val 2"
+		],
+	  	"format" => "string",
+	  	"display_order" => 4
+	}
+]  #Required, Values type : integer, boolean, string, array
+end
+```
+
+
+Please note: Your shops table must have 'plan_id' as int/bigint and 'trial_activated_at' as datetime otherwise add its migration. Sample example: 
+```
+class AddPlanIdToShops < ActiveRecord::Migration[5.2]
+  def change
+    	add_column :shops, :plan_id, :bigint
+    	add_column :shops, :trial_activated_at, :datetime
+  end
+end
+```
+
+and map these new fields in 'config.field_names' in above initializer file.
    
 Step 3) You must have to set ENV variable with key 'APP_MANAGER_ACCESS_TOKEN' in your application.yml or .env file like this:
 
     APP_MANAGER_ACCESS_TOKEN: 'XXXXXXXXXXXXXXXXXXX'
     APP_MANAGER_API_URL: 'https://XXXXXXXX.com'
 
+Steps 4) App Manager provides a rake task that must needs to include in your existing app cron for every 10 minutes. Like if you are using [whenever](https://github.com/javan/whenever) gem then you must need to include following rake take in your 'schedule.rb' (created by whenever gem)
+
+```
+every 10.minutes do
+  rake 'sync:local_app_manager'
+end
+```
+
+Steps 5) App Manager provides a helper module which needs to include in your 'shop' model something like below
+
+```
+class Shop < ActiveRecord::Base
+  include AppManager::Model
+end
+```
+
 
 ## Usage
 
+Using above 5th step you can access following methods from your shop object.
+
+```
+@shop.has_plan # return true or false
+
+@shop.plan_features # return array of plan features of your shop's plan 
+
+@shop.has_feature('feature-1') # provide slug of feature which you set in your 'config.plan_features' in config/initializers/app_manager.rb
+#return true/false
+
+@shop.get_feature('feature-3') #  provide slug of feature and this returns value of feature which is set in portal. 
+
+@shop.get_remaining_days # return integer based on trial activated date.
+```
+
+
+
 #### As a helper:
 
 

data/app/controllers/app_manager/application_controller.rb

@@ -1,5 +1,12 @@
 module AppManager
   class ApplicationController < ActionController::Base
+  	include AppManager::Actions
+  	cache_response_of_app_manager
     protect_from_forgery with: :exception
+    include AppManager::Authenticate
+	# rescue_from StandardError do |exception|
+	# render json: { :error => exception.message }, :status => 500
+	# end
+
   end
 end

data/app/controllers/app_manager/banners_controller.rb

@@ -3,8 +3,13 @@ require_dependency "app_manager/application_controller"
 module AppManager
 	  class BannersController < ApplicationController
 	    def marketing_banner
-				banner_obj = AppManager::Client.new
-				render json: banner_obj.get_banners
+	    		begin
+					banner_obj = AppManager::Client.new
+					render json: banner_obj.get_banners
+	    		rescue Exception => e
+	    			@fs = AppManager::FailSafe.new
+					render json: @fs.get_local_app_structures
+	    		end
 	    end
 	  end
 end

data/app/controllers/app_manager/charges_controller.rb

@@ -0,0 +1,122 @@
+require_dependency "app_manager/application_controller"
+
+module AppManager
+	  class ChargesController < ApplicationController
+	  	include HTTParty
+		skip_before_action :verify_authenticity_token, :only => [:process_plan]
+		before_action :params_permit
+	 	require 'time'
+		require 'rack'
+
+	 	def process_plan
+	    	if params[:shop].present? && params[:plan_id].present? 
+	    		@shop = shop_data
+	    		if !@shop.nil?
+	    		 plan_obj = AppManager::Client.new
+	    		 plan_data = plan_obj.get_plan(params[:plan_id],params[:shop])
+	    		 if plan_data.present? && plan_data.is_a?(Hash) 
+	    		 	request_data = {'shop' => @shop.shopify_domain, 'timestamp' => Time.now.to_i, 'plan' => params[:plan_id]}
+	    		    return_url = "#{app_url}#{plan_callback_path}?#{Rack::Utils.build_query(request_data)}"
+	    		    gq_obj = AppManager::GraphqlHelper.new(@shop.shopify_domain,@shop.shopify_token)
+		    		data = gq_obj.recurring_charge_api_call(plan_data,return_url,@shop)
+					if !data["errors"].present? && (data["data"].present? && data["data"]["appSubscriptionCreate"].present? && ( !data["data"]["appSubscriptionCreate"]["userErrors"].any? && data["data"]["appSubscriptionCreate"]["confirmationUrl"]))
+						redirect_charge = data["data"]["appSubscriptionCreate"]["confirmationUrl"]
+						render json: {'redirect_url' => redirect_charge}
+					else
+						render json: {'error' => data["errors"].as_json}
+					end
+	    		 else
+	    		 	render json: {'error' => data["errors"]}
+	    		 end
+	    		else
+	    			render json: {'error' => 'Shop not found'}
+	    		end
+	        else
+	        	render json: {'error' => 'Missing Shop domain or plan id in params'}
+	    	end
+	    end
+
+
+	    def callback
+			if params[:charge_id].present? && params[:shop].present? && params[:plan].present?
+				@shop = shop_data
+				shopify_token = @field_names['shopify_token']
+				shopify_domain = @field_names['name']
+	    		if !@shop.nil?
+	    			headers = {"X-Shopify-Access-Token" => @shop[shopify_token]}
+	    			charges = HTTParty.get('https://'+@shop[shopify_domain]+'/admin/api/'+@api_version+'/recurring_application_charges/'+params[:charge_id]+'.json', :headers => headers)
+	    			
+	    			if charges.parsed_response && charges.parsed_response.is_a?(Hash) && charges.parsed_response.has_key?('recurring_application_charge')
+ 
+					plan_obj = AppManager::Client.new
+					plan_data = plan_obj.get_plan(params[:plan],params[:shop])
+
+    				charge = charges.parsed_response['recurring_application_charge']
+					charge['charge_id']  = charge['id'];
+					charge['type'] = 'recurring';
+					charge['plan_id'] = params[:plan];
+					charge['shop_domain'] = params[:shop];
+					charge['interval'] = plan_data['interval']['value'];
+
+						if !@plan_field.nil?
+							begin
+								plan_obj.cancel_charge(@shop[shopify_domain],@shop[@plan_field])
+							rescue Exception => e
+								
+							end
+						end
+						charge_ob = AppManager::Client.new(nil,json_req=true)
+						response = charge_ob.store_charge(charge.to_json)
+
+						if response['message'] == "success"
+						model.update(@plan_field => params[:plan])
+						end     					
+						redirect_to "/?shop=#{params[:shop]}"
+	    			else
+
+	    				render json: {'error' => 'Invalid shopify charge'}
+	    			end
+	    		else
+					render json: {'error' => 'Shop not found'}
+	    		end
+			else
+				render json: {'error' => 'Invalid params'}
+			end
+	    end
+
+	    private
+
+	    def params_permit
+	    	params.permit!
+	    end
+
+	    def model
+        	@models = ActiveRecord::Base.connection.tables
+			@config_table = AppManager.configuration.shopify_table_name
+			@shopify_domain = AppManager.configuration.shopify_domain_field
+			@plan_field = AppManager.configuration.plan_id_or_name_field
+			@field_names = AppManager.configuration.field_names
+			@api_version = AppManager.configuration.shopify_api_version
+			if @models.include?(@config_table) && !@plan_field.nil?
+				return @config_table.classify.constantize
+			else
+				return nil
+			end
+        end
+
+	    def shop_data
+			if model
+				return model.where(@shopify_domain => params[:shop]).first rescue nil
+			else
+				return nil
+			end
+	    end
+
+	    def app_url
+	    	AppManager.configuration.app_url
+	    end
+
+
+
+	  end
+end

data/app/controllers/app_manager/plans_controller.rb

@@ -0,0 +1,157 @@
+require_dependency "app_manager/application_controller"
+
+module AppManager
+	  class PlansController < ApplicationController
+		skip_before_action :verify_authenticity_token, :only => [:active_without_plan,:burst_cache,:fail_safe_backup]
+	    def index
+			render :json => {"features" => AppManager.configuration.plan_features || []}
+	    end
+
+	
+	    def plans
+	    	active_plan_id_or_name = shopify_plan = plan = nil
+			default_plan_id = nil
+			plan_obj = AppManager::Client.new
+			plans = plan_obj.get_plans
+			if params[:shop_domain].present? && !AppManager.configuration.plan_features.nil?
+				@shop = shop_data
+				if !@shop.nil?
+					active_plan_id_or_name = @shop[@plan_field] 
+					if !@field_names.nil? && @field_names.has_key?('shopify_plan') && !@field_names.nil?
+					shopify_plan_field = AppManager.configuration.field_names['shopify_plan']
+					shopify_plan = @shop[shopify_plan_field] rescue nil
+					plan = plans.any? && !active_plan_id_or_name.nil? ? (plans.find{|x| x["id"] == active_plan_id_or_name}.present? ? plans.find{|x| x["id"] == active_plan_id_or_name} : nil ) : nil
+				    end
+				else
+					Rails.logger.info "APP MANGAGER >>>>  Either model is defined wrong or config.plan_id_or_name_field is nil in initializer ==="	
+				end	
+			else
+    			 Rails.logger.info "APP MANGAGER >>>>  Either params missing store_domain or config.plan_features is nil in initializer ==="	
+			end
+
+
+			default_plan_id = 0;
+			default_plan_data = plans.select{|x| x['interval'] == 'EVERY_30_DAYS' }.sort_by { |k| -k["price"] }
+			store_base_plan = default_plan_data.map{|e| e['store_base_plan']}.first rescue false 
+
+			if store_base_plan
+				begin
+					shopify_plans = default_plan_data.map { |e| e.map { |key, value| [e['shopify_plans'], e['id']] }.to_h }
+					shopify_plans.each do |shp|
+						if shp.keys && shp.keys.first && shp.keys.first.class == Array
+							if shp.keys.first.include?(shopify_plan) && shp.values && shp.values.first && shp.values.first.to_i > 0
+								default_plan_id = shp.values.first.to_i
+								break
+							end
+						end
+					end
+				rescue Exception => e
+					Rails.logger.info "APP MANGAGER >>>> ERROR #{e.inspect}"				
+				end
+			else
+				default_plan_id = default_plan_data.map{|e| e['id']}.first if default_plan_data.any? rescue nil
+			end
+
+			response = {
+				'plans' => plan_obj.get_plans,
+				'shopify_plan' => shopify_plan,
+				'plan' => plan,
+				'default_plan_id' => default_plan_id
+			}
+			render json: response
+	    end
+
+		def users
+			if model
+				data = model.page(params[:page]).per(10)
+				users = {
+				"current_page" => data.current_page,
+				"data" => data.collect{|st| @field_names.map{ |key, value| [key, "#{st[value]}"] }.to_h },
+				"first_page_url" => "#{app_url}/api/app-manager/users?page=1",
+				"from" => data.total_pages ? 1 : nil,
+				"last_page" => data.total_pages,
+				"last_page_url" => data.total_pages ? "#{app_url}/api/app-manager/users?page=#{data.total_pages}" : nil,
+				"links"=> '',
+				"next_page_url" => data.next_page ? "#{app_url}/api/app-manager/users?page=#{data.next_page}" : nil,
+				"path" => "#{app_url}/api/app-manager/users", 
+				"per_page" => 1,
+				"prev_page_url" => data.prev_page ? "#{app_url}/api/app-manager/users?page=#{data.prev_page}" : nil,
+				"to" => data.total_pages,
+				"total" => data.total_pages 
+				}
+				render json: users
+
+			else	
+				render json: nil
+			end	
+		end
+
+		def active_without_plan
+			if params[:shop_domain].present? && params[:plan_id].present? && model
+				@trial_activated_field = AppManager.configuration.field_names['trial_activated_at'] 
+				model.update(@plan_field => params[:plan_id],@trial_activated_field => DateTime.now)
+				render json: {'status' => true}
+			else
+				render json: {'status' => false,'error' => 'Shop not found or missing shop'}, status: 422
+			end
+		end
+
+
+		def burst_cache
+	    	AppManager.clear_cache
+			head :ok	
+	    end
+
+
+	    def fail_safe_backup
+	    	params_permit
+	    	@fs = AppManager::FailSafe.new
+	    	begin
+	    		@fs.sync_app_manager	
+	    	rescue Exception => e
+	    		Rails.logger.info "APP MANGAGER >>>> LOCAL DB couldn't sync with POTAL DB #{e.inspect}"
+	    	end
+
+	    	begin
+	    	@fs.save_api_data(params)
+	    	rescue Exception => e
+	    	Rails.logger.info "APP MANGAGER >>>> #{e.inspect}"	
+	    	end
+	    	head :ok
+	    end
+
+
+        private
+
+        def params_permit
+	    	params.permit!
+	    end
+
+        def model
+        	@models = ActiveRecord::Base.connection.tables
+			@config_table = AppManager.configuration.shopify_table_name
+			@shopify_domain = AppManager.configuration.shopify_domain_field
+			@plan_field = AppManager.configuration.plan_id_or_name_field
+			@field_names = AppManager.configuration.field_names
+			@api_version = AppManager.configuration.shopify_api_version
+			if @models.include?(@config_table) && !@plan_field.nil?
+				return @config_table.classify.constantize
+			else
+				return nil
+			end
+        end
+
+	    def shop_data
+			if model
+				return model.where(@shopify_domain => params[:shop_domain]).first rescue nil
+			else
+				return nil
+			end
+	    end
+
+	    def app_url
+	    	AppManager.configuration.app_url
+	    end
+
+	  end
+end

data/app/controllers/concerns/app_manager/authenticate.rb

@@ -0,0 +1,10 @@
+module AppManager
+  module Authenticate
+    extend ActiveSupport::Concern
+
+    included do
+      include AppManager::Protection
+      before_action :authorize_request, :only => [:users]
+    end
+  end
+end

data/app_manager.gemspec

@@ -32,8 +32,8 @@ Gem::Specification.new do |spec|
   # spec.add_dependency "example-gem", "~> 1.0"
   spec.add_dependency "httparty"
   spec.add_dependency "rails",   '>= 5.2.0'
-
-
+  spec.add_dependency "kaminari",   '>= 0.16.3'
+  spec.add_dependency "sqlite3", '~> 1.3.0'
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
 end

data/config/routes.rb

@@ -1,5 +1,18 @@
 AppManager::Engine.routes.draw do
   scope 'api/app-manager' do
      get 'marketing-banners' => 'banners#marketing_banner'
+
+	 get 'plan-features' => 'plans#index'
+	 get 'plans' => 'plans#plans'
+	 get 'users' => 'plans#users'
+     post 'active-without-plan' => 'plans#active_without_plan'
+	 post 'burst-cache' => 'plans#burst_cache'
+	 post 'fail-safe-backup' => 'plans#fail_safe_backup'
+     get 'plan/process/:plan_id' => 'charges#process_plan'
+     get 'plan/callback' => 'charges#callback', as: :plan_callback
+
+		scope 'app-manager-api' do
+			post 'store-charge' => 'plans#store_charge'
+		end
   end
-end
+end

data/lib/app_manager/actions.rb

@@ -0,0 +1,10 @@
+module AppManager
+  module Actions
+    extend ActiveSupport::Concern
+    module ClassMethods
+      def cache_response_of_app_manager
+        around_action  ApiCacheHandler.new
+      end
+    end
+  end
+end

data/lib/app_manager/api_cache_handler.rb

@@ -0,0 +1,67 @@
+module AppManager
+  module Actions
+    class ApiCacheHandler
+      def initialize
+        
+      end
+
+
+      def around(controller)
+        init(controller)
+        if should_response_cache?
+          log_info
+          render_cached_response
+        else
+          yield
+          @response_cache.write_cache(controller.response) if @request.get?
+        end
+      end
+
+      protected
+
+      def should_response_cache?
+       return @request.get? && @response_cache.cached_response.present?
+      end
+
+      def log_info
+        # processor       = "#{@controller.class.name}##{@controller.action_name}".blue
+        # responder       = Rainbow('API Response Cache').green
+        Rails.logger.info "=== #{@controller.class.name}##{@controller.action_name} response by App Manager Response Cache ==="
+      end
+
+      def init(controller)
+        @controller         = controller
+        @request            = controller.request
+        @response_cache     = ResponseCache.new(cache_path)
+      end
+
+      def cache_path
+        @cache_path = "app-manager-cache"
+
+        path_only   = @request.fullpath.split('?').first
+        @cache_path = "#{@cache_path}#{path_only}"
+
+        if AppManager.configuration.cache_by_headers.present?
+          headers = AppManager.configuration.cache_by_headers.map do |header|
+            @request.headers[header].to_s
+          end
+          headers_cache_path = headers.join('-')
+          @cache_path = "#{@cache_path}/#{headers_cache_path}"
+        end
+
+        @cache_path
+      end
+
+      def render_cached_response
+        body    = @response_cache.body
+        status  = @response_cache.status
+        headers = @response_cache.headers
+        headers.try(:each) do |key, value|
+          @controller.response.headers[key] = value
+        end
+        @controller.render plain: body, status: status 
+      end
+    end
+  end
+end
+

data/lib/app_manager/client/banners.rb

@@ -2,7 +2,7 @@ module AppManager
 	class Client
 			module Banners
 
-				def get_banners(options = {})
+			  def get_banners(options = {})
 				  get("/static-contents", options)
 			  end
 

data/lib/app_manager/client/connection.rb

@@ -24,9 +24,19 @@ module AppManager
 
       def request(http_method, path, options)
         response = self.class.send(http_method, path, { body: options })
-        return nil unless response
-        data = response.parsed_response
-        data = parse_data(response.parsed_response)
+        if path.include? "/get-status"
+          data = response
+        elsif path.include? "/sync-charge" 
+          data = response.parsed_response
+          data = parse_data(response.parsed_response)
+        else
+          if response.code.to_s.start_with?('2') or response.code.to_s.start_with?('4')
+          data = response.parsed_response
+          data = parse_data(response.parsed_response)
+          else
+          data = response_from_failsafe(path,options) 
+          end
+        end
       end
 
       def parse_data(original_data)
@@ -36,7 +46,31 @@ module AppManager
         else 
           return original_data
         end
+      end
 
+      def response_from_failsafe(path,options)
+        params = Rack::Utils.parse_query URI(path).query
+        path = path.delete_prefix('/')
+        path = path[/[^?]+/]
+        @fs = AppManager::FailSafe.new
+        case path
+        when "static-contents"
+          return @fs.get_local_app_structures
+        when 'plans'
+          return @fs.get_local_plans
+        when 'plan'
+          return @fs.get_local_plan(params)
+        when 'store-charge'
+          return @fs.store_local_charge(params,options)  
+        when 'cancel-charge'
+          return @fs.store_cancel_charge(params,options)
+        when 'get-remaining-days' 
+          return @fs.get_local_remaining_days(params,options)
+        when 'get-charge'
+          return @fs.get_local_charge(params,options)  
+        else
+         return nil
+        end
       end
 
     end