fyipe 3.0.11509 → 3.0.11510

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a29095c9180ccf242aa34ad144a6a6b0b96a6faf118373fcf00972b9c949157
-  data.tar.gz: 87e79478cbdeeba90c1cea327acf5a15123f1e1cf720ce897e7fe22bba654512
+  metadata.gz: 4c58a0d79a0b625e24968066aec2937fe208df798a1bf01733b14b6220dde799
+  data.tar.gz: 5556acf34847a3178be8b4296324d3ea83ac103d78f9ebc2510f6df79cb027b9
 SHA512:
-  metadata.gz: c2617bd4eae203204279eada0e7c499f070342a88b506c3a682c9f4ad15cf41b29f3bb086325b80cff4355aa51add1b59c677622a55384a4b9cce811449d954a
-  data.tar.gz: 302714f24db9073ee0e94091620e17823198b90fd5da42019090651ad7368ce6ede8fdfad983f196b05a0f7b9749b44914c913ca7d83889cff578f86cd617361
+  metadata.gz: 7417a85d51f46489083e528af27b756174b6bb95f7a6be8e9883ec5f305e9d0e152fb4513c406c6d11af57b901afa3876618abcf2dade43e49b9621acd19e006
+  data.tar.gz: 84b57be6b5cfba2f6c0106463b72a2b5edafaa4b8ee93e033681da1d7e064b6106c17a94288fc43674e87726fc13f8f9f6762e89976dfc09e1d0f6264bde422f

data/.gitignore

@@ -0,0 +1,14 @@
+vendor/
+.bundle/
+*.gem
+coverage/*
+Gemfile.lock
+*~
+.rvmrc
+log/*
+measurement/*
+pkg/*
+.DS_Store
+.env
+spec/dummy/tmp/*
+spec/dummy/log/*.log

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+require:
+ - rubocop-performance
+ - rubocop-rspec
+ 
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable

data/RakeFile

@@ -0,0 +1,6 @@
+require 'rake'
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end

data/demo.rb

@@ -0,0 +1,25 @@
+require_relative 'lib/fyipe'
+
+# instance=Fyipe.config do |c|
+#     c.applicationLogId = 'Testing'
+# end 
+
+# puts Fyipe.applicationLogId
+
+obj = FyipeLogger.new(
+    'http://localhost:3002/api',
+    '5eeba14a3b0014dfbe07124a',                    
+    '0292c716-089c-491e-8f30-b8a0ce4e0250'
+)
+
+obj.display()
+
+# obj.log("heyy")
+# obj.log(64)
+# obj.log(['content', 'here'])
+obj.log({'content'=> 'here'})
+obj.warning('heyy')
+obj.error({'content'=> 'another try'})
+# obj.log({:sk => "here"})
+
+# puts logger

data/fyipe.gemspec

@@ -12,11 +12,11 @@ Gem::Specification.new do |spec|
     spec.license               = 'MIT'
     spec.platform              = Gem::Platform::RUBY
     spec.required_ruby_version = '>= 2.5.0'
-    spec.files = Dir['README.md', 'LICENSE',
-                 'CHANGELOG.md', 'ruby-sdk/**/*.rb',
-                 'ruby-sdk/**/*.rake',
-                 'fyipe.gemspec', '.github/*.md',
-                 'Gemfile', 'Rakefile']
+
+    all_files = `git ls-files`.split("\n")
+    test_files = `git ls-files -- {spec}/*`.split("\n")
+
+    spec.files = all_files - test_files
     spec.extra_rdoc_files = ['README.md']
     spec.add_dependency 'httparty', '~> 0.17'
     spec.add_dependency 'gem-release'

data/lib/fyipe.rb

@@ -0,0 +1,76 @@
+require 'httparty'
+
+class FyipeLogger
+    
+    include HTTParty
+    # FyipeLogger constructor.
+    # @param string apiUrl
+    # @param string applicationLogId
+    # @param string applicationLogKey
+    
+    def initialize(apiUrl, applicationLogId, applicationLogKey)
+        # instance variable intialzation
+        @applicationLogId = applicationLogId
+        setApiUrl(apiUrl)
+        @applicationLogKey = applicationLogKey
+    end
+
+    def setApiUrl(apiUrl)
+        @apiUrl = apiUrl + '/application-log/' + @applicationLogId + '/log';
+    end
+
+    def validateItems(content, tags)
+         # get the class of the content and convert to string for comparison
+         contentType = content.class.to_s
+         tagType = tags != nil ? tags.class.to_s : nil
+         
+         # check if content type is not a string or hash object
+         if(!((contentType.eql? "String") || (contentType.eql? "Hash")))
+             raise "Invalid Content to be logged"
+         end
+ 
+         # check if tag type is avialable and its not a string or hash object
+         if(tagType != nil && (!((tagType.eql? "String") || (tagType.eql? "Array"))))
+             raise "Invalid Content Tags to be logged"
+         end
+    end
+
+    def log(content, tags = nil)
+        validateItems(content, tags)
+
+        #set log type
+        logType = "info";
+        return makeApiRequest(content, logType, tags)
+    end
+
+    def warning(content, tags = nil)
+        validateItems(content, tags)
+
+        #set log type
+        logType = "warning";
+        return makeApiRequest(content, logType, tags)
+    end
+
+    def error(content, tags = nil)
+        validateItems(content, tags)
+
+        #set log type
+        logType = "error";
+        return makeApiRequest(content, logType, tags)
+    end
+
+    def makeApiRequest(data, type, tags = nil)
+        # make api request and return response 
+        
+        body = { content: data, type: type, applicationLogKey: @applicationLogKey }
+        if (tags != nil)    
+            body['tags'] = tags;
+        end 
+        params = { body: body }
+
+        response = self.class.post(@apiUrl, params).parsed_response
+        return response
+    
+    end
+
+end

data/lib/fyipe/version.rb

@@ -0,0 +1,3 @@
+module Fyipe
+    VERSION = '3.0.11510'
+end

data/spec/fyipe_logger_spec.rb

@@ -0,0 +1,148 @@
+# spec/fyipe_logger_spec.rb
+require_relative '../lib/fyipe'
+require_relative 'helper'
+
+RSpec.configure do |config|
+    config.before(:suite){
+        # using $ registers the variable as a global variable
+        # ref: https://stackoverflow.com/a/19167379/6800815
+        $apiUrl = 'http://localhost:3002/api'
+        $helper = Helper.new()
+        sampleUser = $helper.getSampleUser()
+
+        begin
+            # create user
+            createdUser = $helper.makeApiRequest($apiUrl+"/user/signup", sampleUser)
+
+            # get token and project
+            $token = createdUser['tokens']['jwtAccessToken']
+            $project = createdUser['project']
+
+            # create a component
+            component = { 'name' => $helper.getTitle() }
+            $createdComponent = $helper.makeApiRequest($apiUrl+"/component/"+$project["_id"], component, $token) 
+            
+            # create an applicationlog and set it as the global application Log.
+            appLog = { 'name' => $helper.getTitle() }
+            $applicationLog = $helper.makeApiRequest($apiUrl+"/application-log/"+$project["_id"]+"/"+$createdComponent["_id"]+"/create", appLog, $token)
+        rescue => exception
+            puts "Couldnt create an application log to run a test, Error occured: #{exception.message}"
+        ensure
+            puts "All clear, Tests will commence now"
+        end 
+                        
+    }
+end
+
+RSpec.describe FyipeLogger do
+    it 'test_application_log_key_is_required' do
+        logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], '')
+        response = logger.log('test content')
+        expect(response['message']).to eql 'Application Log Key is required.'
+    end
+    it 'test_content_is_required' do
+        logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
+        response = logger.log('')
+        expect(response['message']).to eql 'Content to be logged is required.'
+    end
+    it 'test_valid_applicaiton_log_id_is_required' do
+        logger = FyipeLogger.new($apiUrl, "5eec6f33d7d57033b3a7d502", $applicationLog["key"])
+        response = logger.log('test')
+        expect(response['message']).to eql 'Application Log does not exist.'
+    end
+    it 'test_valid_string_content_of_type_info_is_logged' do
+        log = "sample content to be logged"
+        logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
+        response = logger.log(log)
+        expect(response['content']).to eql log
+        expect(response['content'].class.to_s).to eql "String"
+        expect(response['type']).to eql "info"
+    end
+    it 'test_valid_object_content_of_type_info_is_logged' do
+        log = {
+            "name" => "Tony Lewinsky",
+            "location" => "Liverpool"
+        }
+        logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
+        response = logger.log(log)
+        expect(response['content']["location"]).to eql log["location"]
+        expect(response['content'].class.to_s).to eql "Hash"
+        expect(response['type']).to eql "info"
+    end
+    it 'test_valid_string_content_of_type_error_is_logged' do
+        log = "sample content to be logged"
+        logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
+        response = logger.error(log)
+        expect(response['content']).to eql log
+        expect(response['content'].class.to_s).to eql "String"
+        expect(response['type']).to eql "error"
+    end
+    it 'test_valid_object_content_of_type_warning_is_logged' do
+        log = {
+            "name" => "Tony Lewinsky",
+            "location" => "Liverpool"
+        }
+        logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
+        response = logger.warning(log)
+        expect(response['content']["location"]).to eql log["location"]
+        expect(response['content'].class.to_s).to eql "Hash"
+        expect(response['type']).to eql "warning"
+    end
+    it 'test_valid_object_content_of_type_warning_with_one_tag_is_logged' do
+        log = {
+            "name" => "Tony Lewinsky",
+            "location" => "Liverpool"
+        }
+        tag = "Famous";
+        logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
+        response = logger.warning(log, tag)
+        expect(response['content']["location"]).to eql log["location"]
+        expect(response['content'].class.to_s).to eql "Hash"
+        expect(response['type']).to eql "warning"
+        expect(response['tags'].class.to_s).to eql "Array"
+        expect(response['tags'].find { |item| item == tag }).to_not be_nil
+    end
+    it 'test_valid_object_content_of_type_error_with_no_tag_is_logged' do
+        log = "sample content to be logged"
+        logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
+        response = logger.error(log)
+        expect(response['content']).to eql log
+        expect(response['content'].class.to_s).to eql "String"
+        expect(response['type']).to eql "error"
+        expect(response['tags'].class.to_s).to eql "Array"
+        expect(response['tags']).to eql []
+    end
+    it 'test_valid_object_content_of_type_warning_with_four_tags_is_logged' do
+        log = {
+            "name" => "Tony Lewinsky",
+            "location" => "Liverpool"
+        }
+        tags = ['testing', 'rubylansh', 'trial', 'correct']
+        logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
+        response = logger.warning(log, tags)
+        expect(response['content']["location"]).to eql log["location"]
+        expect(response['content'].class.to_s).to eql "Hash"
+        expect(response['type']).to eql "warning"
+        expect(response['tags'].class.to_s).to eql "Array"
+        tags.each {
+            |tag| expect(response['tags'].find { |item| item == tag }).to_not be_nil
+        }
+
+    end
+    it 'test_valid_object_content_of_type_warning_return_invalid_tags' do
+        log = {
+            "name" => "Tony Lewinsky",
+            "location" => "Liverpool"
+        }
+        tags = {"content" => "test"}
+        logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
+        begin
+            response = logger.warning(log, tags)
+        rescue => exception
+            expect(exception.message).to eql 'Invalid Content Tags to be logged'
+        ensure
+            
+        end
+        
+    end
+end

data/spec/helper.rb

@@ -0,0 +1,49 @@
+require 'faker'
+require 'httparty'
+
+class Helper 
+    include HTTParty
+
+    def getTitle() 
+        return Faker::Movie.title
+    end
+    def getSampleUser()
+        user = {
+            'name'=> Faker::Name.name,
+            'password' => '1234567890',
+            'confirmPassword' => '1234567890',
+            'email' => Faker::Internet.email,
+            'companyName' => Faker::Company.name,
+            'jobTitle' => Faker::Company.profession,
+            'companySize' => Faker::Number.between(from: 1, to: 100),
+            'card' => {
+                'stripeToken' => 'tok_visa'
+            },
+            'subscription' => {
+                'stripePlanId' => 0
+            },
+            'cardName' => Faker::Stripe.valid_token,
+            'cardNumber' => Faker::Stripe.valid_card,
+            'expiry' => Faker::Stripe.valid_card,
+            'cvv' => 123,
+            'city' => Faker::Address.city,
+            'state' => Faker::Address.state,
+            'zipCode' => Faker::Address.zip_code,
+            'planId' => 'plan_GoWIYiX2L8hwzx',
+            'companyRole' => Faker::Company.profession,
+            'companyPhoneNumber' => Faker::Company.profession,
+            'reference' => 'Github',
+        } 
+        return user
+    end
+
+    def makeApiRequest(url, data, token = nil)
+        # make api request and return response 
+        params = { body: data, headers: token == nil ? nil : {Authorization: 'Basic '+token}}
+
+
+        response = self.class.post(url, params).parsed_response
+        return response
+    
+    end
+end 

data/spec/spec_helper.rb

@@ -0,0 +1,101 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fyipe
 version: !ruby/object:Gem::Version
-  version: 3.0.11509
+  version: 3.0.11510
 platform: ruby
 authors:
 - HackerBay, Inc.
@@ -131,11 +131,21 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
+- RakeFile
+- demo.rb
 - fyipe.gemspec
+- lib/fyipe.rb
+- lib/fyipe/version.rb
+- spec/fyipe_logger_spec.rb
+- spec/helper.rb
+- spec/spec_helper.rb
 homepage: https://github.com/Fyipe/ruby-sdk
 licenses:
 - MIT