earnshark_sdk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 552517a7cffae1ded66990a624ed1bb2ea6b6caa
-  data.tar.gz: 4f3ede03227f96cf25c01010abf70fa16fa98cbb
+  metadata.gz: 107bd08248d33f3f894d13e2a92545cc91662d24
+  data.tar.gz: 8d8be18a72dba4783ff29851ade2139e28b35866
 SHA512:
-  metadata.gz: 4fe9f4dee46d71555d7f35f0039eda59f9bc180e88d1992c68ac93c4c9af35109785612ea046f19186bbdae384ef6d1919d3ac392e7810f5d2b8d643b4819348
-  data.tar.gz: 0584538f553dabf7cd2d1bc7cc2f3f402ed4b8d4e3b1f3c8f6452d465b2d473636e932355906564a340054f43dc11b2d97d94ae969235366594eb2116b2520fc
+  metadata.gz: 656fa8ad75c41ab052d581fd60c63c8cd66ee316e6544728b78d7f392c8ae1f8196b3dd1505f4c22801bda18317c66a146300ed85dc05f98eb95f38f7c6f0db3
+  data.tar.gz: 7c0b7ad7cf3c58f05c5c7abc615b0f30d9e8172d7ce70886f9fc0aeca4c257e0d57eb3ecdbf12e4b4a021b10a27f68aebab75a0de9300df8d36418a540aa2e4e

data/Gemfile

@@ -2,4 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in earnshark_sdk.gemspec
 gemspec
-gem "http"
+gem "public_suffix", "1.4.6"
+gem "http","1.0.4"

data/README.md

@@ -1,10 +1,26 @@
 # Earnshark SDK for Ruby
+![sdk ruby](https://img.shields.io/badge/sdk-Ruby-ff69b4.svg)
+[![Gem Version](https://badge.fury.io/rb/earnshark_sdk.svg)](https://badge.fury.io/rb/earnshark_sdk)
+[![Join the chat at https://gitter.im/99xt/earnshark-sdk-js](https://badges.gitter.im/99xt/earnshark-sdk-js.svg)](https://gitter.im/99xt/earnshark-sdk-js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)
+[![license](https://img.shields.io/npm/l/earnshark-sdk.svg)](https://www.npmjs.com/package/earnshark-sdk)
 
-This is a JavaScript SDK to call https://app.earnshark.com API. Contains methods to call the EarnShark API making the application integration fast.
+This is a Ruby SDK to call https://app.earnshark.com API endpoints. Contains methods to call the EarnShark API making the application integration fast. 
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/earnshark_sdk`. To experiment with that code, run `bin/console` for an interactive prompt.
+at RubyGems : https://rubygems.org/gems/earnshark_sdk
 
-TODO: Delete this and the text above, and describe your gem
+## Functions Available 
+
+* Accounts:
+  * get_account_information - Retrieve information on a particular account/subscription
+  * get_account_payments - Returns all the payment transactions associated with the account
+* Licenses:
+  * get_license_information - Retrieve information on a particular license
+  * get_all_licenses_of_product - Retrieve all the license data for a particular product
+* Subscriptions: 
+  * new_subscription - Add a new subscription to a product
+  * renew_subscription - Renew/Update a Subscription
+  * get_payment_url - Returns the payment portal URL for a subscription(linked to PayPal)
 
 ## Installation
 
@@ -21,10 +37,90 @@ And then execute:
 Or install it yourself as:
 
     $ gem install earnshark_sdk
+    
 
 ## Usage
 
-TODO: Write usage instructions here
+Initiliaze the Object,
+
+The token key and the product ID are required (this can be taken from the EarnShark dashboard)
+```ruby
+key = ""
+product_id = 9
+
+```
+
+```ruby
+require 'earnshark_sdk/api'
+earnshark = EarnShark::Api::Client.new(product_id, key)
+```
+
+### Add New Account
+Creating new account, you need to pass the following data in the structure to the method
+```ruby
+body = {
+            :account => {
+                    :name =>"Account Name",
+                    :email => "Account@example.com",
+                    :accountID => "12345678",
+                    :start_date =>  "01/01/2016"
+                },
+                :license_id => 17,
+                :enableNotifications => false,
+                :sendInvoiceNow => true
+         }
+```
+
+```ruby
+addNewRes = earnshark.new_subscription(body)
+```
+
+### Get account information
+You will need to pass the account id for this,
+
+```ruby
+account_id = "123456"
+accountInfo= earnshark.get_account_information(account_id)
+```
+
+### Renew a subscription with a new license
+You will need to pass the current subscription id and the new license id to renew
+
+```ruby
+subscription_id = 84
+new_license_id = 20
+
+renew_subs= earnshark.renew_subscription( subscription_id, new_license_id )
+```
+
+### Get license information for a single license
+Get the license information using the license id and the license token
+
+```ruby
+license_id = 17
+license_token = ''
+
+get_license= earnshark.get_license_information( license_id, license_token )
+```
+
+### Get all the licenses
+Get all the licenses information
+```ruby
+all_licenses= earnshark.get_all_licenses_of_product()
+```
+
+### Get Transaction details for an account
+Retrieve the processed/unprocessed transactions for an account
+```ruby
+account_transaction= earnshark.get_account_payments(account_id)
+```
+
+### Generate Payment URL to transfer to paymen gateway
+Redirect URL is need to passed here as well
+```ruby
+redirect = 'http://app.earnshark.com';
+payment_url= earnshark.get_payment_url(account_id, redirect)
+```
 
 ## Development
 

data/Rakefile

@@ -4,3 +4,7 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+task :console do
+  exec "irb -r earnshark_sdk -I ./lib"
+end

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "earnshark_sdk"
+#require "earnshark_sdk"
+require "ruby/earnshark_sdk/api"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/earnshark_sdk.gemspec

@@ -1,19 +1,28 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'earnshark_sdk/version'
+require 'earnshark_sdk/api/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "earnshark_sdk"
-  spec.version       = EarnsharkSdk::VERSION
+  spec.version       = EarnShark::Api::VERSION
   spec.authors       = ["Chamath Palihawadana"]
   spec.email         = ["chamathpali123@gmail.com"]
 
-  spec.summary       = %q{EarnShark SDK}
-  spec.description   = %q{This is a Ruby SDK to call https://app.earnshark.com API endpoints. Contains methods to call the EarnShark API making the application integration fast.}
+  spec.summary       = "This is a Ruby SDK to call https://app.earnshark.com API endpoints"
+  spec.description   = "This is a Ruby SDK to call https://app.earnshark.com API endpoints. Contains methods to call the EarnShark API making the application integration fast"
   spec.homepage      = "https://github.com/99xt/earnshark-sdk-ruby"
   spec.license       = "MIT"
 
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end

data/lib/earnshark_sdk/api.rb

@@ -0,0 +1,48 @@
+# Base ruby requirements
+require "http"
+
+# Gem requirements
+require "earnshark_sdk/api/account"
+require "earnshark_sdk/api/license"
+require "earnshark_sdk/api/request"
+require "earnshark_sdk/api/subscription"
+require "earnshark_sdk/api/version"
+
+module EarnShark
+  module Api
+    class Client
+      include Account
+      include License
+      include Request
+      include Subscription
+
+      #initialize the object with the earnshark product id and token provided
+      def initialize(product_id,key)
+        @product_id, @key = product_id , key
+        @base_url = BASE_URL
+        @app_dir = APP_DIR
+      end
+
+      def app_dir
+        @app_dir
+      end
+
+      def base_url
+        @base_url
+      end
+
+      def get_obj
+        "product_id = #@product_id , token = #@key"
+      end
+
+      def post(url, body)
+        HTTP.post(url, :json => body)
+      end
+
+      def get(url)
+        HTTP.get(url).body
+      end
+
+    end
+  end
+end

data/lib/earnshark_sdk/api/account.rb

@@ -0,0 +1,18 @@
+module EarnShark
+  module Account
+    # Get Account Information
+    # Example response:
+    #   [ { "Date":"01/01/2016", "Cost":{ "value":"100", "currency":"USD" }, "Name":"5 Users Plan", "Product_ID":1, "Customer_ID":1, "Customer_Name":"Customer Name", "Account_ID":"123456", "Metadata":"{\"users\":\"10 users\"}", "Subscription_ID":1, "Tags":[ "10users" ], "License_ID":1, "Invalid":false, "Expired":false, "Billing_Cycle":{ "value":1, "type":"Monthly" }, "Description":"10 Users per month / 100", "Tenant_ID":"eu-west-1:00000000-0000-0000-0000-000000000000" } ]
+    def get_account_information(account_id)
+      get("#{base_url}#{@product_id}/subscriptioninfo/#{account_id}?key=#{@key}")
+    end
+
+    # Get the payment transactions for an account
+    # Example response:
+    #   [ { "Amount":"100", "Created_At":"1474872974062", "Currency":"USD", "Product_ID":1, "PayPal_Transaction":"PAY-11111111111", "Updated_At":"1474872974062", "Account_ID":"local", "PayPal_Payer_ID":"111111", "Subscription_ID":1, "Payment_Processed":true, "Payout_ID":"12345", "Payment_Sent":true, "PayPal_Payment_ID":"PAY-11111111111" } ]'
+    def get_account_payments(account_id)
+      get("#{base_url}#{@product_id}/account/#{account_id}/transactions?key=#{@key}")
+    end
+
+  end
+end

data/lib/earnshark_sdk/api/license.rb

@@ -0,0 +1,18 @@
+module EarnShark
+  module License
+    # Get Information of a license created
+    # Example response:
+    #   { "Name":"License Name", "Cost":{ "value":"100", "currency":"USD" }, "Tags":[ "10 User Package" ], "License_ID":1, "Product_ID":1, "Description":"10 Users per month / 100", "Billing_Cycle":{ "value":1, "type":"Monthly" }, "Metadata":"{\"users\":\"10\"}" }
+    def get_license_information(license_id, license_token)
+      get("#{base_url}#{@product_id}/license/#{license_id}/getlicensefromapi?key=#{license_token}")
+    end
+
+    # Get all the Licenses of the current product
+    # Example response:
+    #   [{"Name":"License Name","Cost":{"value":"10","currency":"USD"},"Tags":["free","test","trial"],"License_ID":1,"Product_ID":1,"Description":"Test","Billing_Cycle":{"value":1,"type":"Monthly"},"Metadata":"{}"}]
+    def get_all_licenses
+      get("#{base_url}#{@product_id}/license/all?key=#{@key}")
+    end
+    
+  end
+end

data/lib/earnshark_sdk/api/request.rb

@@ -0,0 +1,17 @@
+module EarnShark
+  module Request
+    BASE_URL = 'https://app.earnshark.com/prod/product/'.freeze
+    APP_DIR = 'http://earnsharkbeta.com.s3-website-eu-west-1.amazonaws.com/'.freeze
+  end
+
+=begin
+  def post(url, body)
+    HTTP.post(url, :json => body)
+  end
+
+  def get(url)
+    HTTP.get(url).body
+  end
+=end
+
+end

data/lib/earnshark_sdk/api/subscription.rb

@@ -0,0 +1,23 @@
+module EarnShark
+  module Subscription
+    # Adding new Subscription
+    # Example response:
+    #   { "status":"success", "message":"Subscription created without notifications and without invoice" }
+    def new_subscription(body)
+      post("#{base_url}#{@product_id}/addsubscriptionfromapi?key=#{@key}", body)
+    end
+
+    # Renew an Existing subscription
+    # Example response:
+    #   { "Date":"01/01/2016", "Cost":{ "value":"100", "currency":"USD" }, "Name":"5 Users Plan", "Product_ID":1, "Customer_ID":1, "Customer_Name":"Customer Name", "Account_ID":"123456", "Metadata":"{\"users\":\"10 users\"}", "Subscription_ID":1, "Tags":[ "10users" ], "License_ID":1, "Invalid":false, "Expired":false, "Billing_Cycle":{ "value":1, "type":"Monthly" }, "Description":"10 Users per month / 100", "Tenant_ID":"eu-west-1:00000000-0000-0000-0000-000000000000" }
+    def renew_subscription(subscription_id, new_license_id)
+      get("#{base_url}#@product_id/subscription/#{subscription_id}/apiRenewSubscription/#{new_license_id}?key=#@key")
+    end
+
+    # Get payment URL
+    def get_payment_url(account_id, redirect)
+      "#{app_dir}"+"payment.html?redirect=#{redirect}&productID=#@product_id&accountID=#{account_id}&key=#@key"
+    end
+
+  end
+end

data/lib/earnshark_sdk/api/version.rb

@@ -0,0 +1,5 @@
+module EarnShark
+  module Api
+    VERSION = "0.2.0".freeze
+  end
+end

metadata

@@ -1,68 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: earnshark_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chamath Palihawadana
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2016-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 description: This is a Ruby SDK to call https://app.earnshark.com API endpoints. Contains
-  methods to call the EarnShark API making the application integration fast.
+  methods to call the EarnShark API making the application integration fast
 email:
 - chamathpali123@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -71,30 +71,35 @@ files:
 - bin/console
 - bin/setup
 - earnshark_sdk.gemspec
-- lib/earnshark_sdk.rb
-- lib/earnshark_sdk/version.rb
+- lib/earnshark_sdk/api.rb
+- lib/earnshark_sdk/api/account.rb
+- lib/earnshark_sdk/api/license.rb
+- lib/earnshark_sdk/api/request.rb
+- lib/earnshark_sdk/api/subscription.rb
+- lib/earnshark_sdk/api/version.rb
 homepage: https://github.com/99xt/earnshark-sdk-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: EarnShark SDK
+summary: This is a Ruby SDK to call https://app.earnshark.com API endpoints
 test_files: []

data/lib/earnshark_sdk.rb

@@ -1,106 +0,0 @@
-require "earnshark_sdk/version"
-require "http"
-
-module EarnShark
-  class API
-
-    #initialize the object with the earnshark product id and token provided
-  	def initialize(product_id,key)
-  		@product_id, @key = product_id , key
-  		@isTest = false
-  		#URLS
-  		@baseURL = 'https://app.earnshark.com/prod/product/';
-		  @appDir = 'http://earnsharkbeta.com.s3-website-eu-west-1.amazonaws.com/';
-  	end
-
-  	def isTest(yes)
-  		if(yes)
-  			@isTest = true;
-  		end
-  	end
-
-  	# Adding new Subscription 
-  	def add_new_subscription(body)
-  		# When test is true  
-  		if(@isTest)
-  			'{ "status":"success", "message":"Subscription created without notifications and without invoice" }'
-  		else
-        url = "#@baseURL#@product_id/addsubscriptionfromapi?key=#@key"
-  	  	response =HTTP.post( url , :json => body)
-        "#{response}"
-  		end
-
-  	end
-
-  	# Get Account Information
-  	def get_account_information(account_id)
-  		# When test is true
-  		if(@isTest)
-  			'[ { "Date":"01/01/2016", "Cost":{ "value":"100", "currency":"USD" }, "Name":"5 Users Plan", "Product_ID":1, "Customer_ID":1, "Customer_Name":"Customer Name", "Account_ID":"123456", "Metadata":"{\"users\":\"10 users\"}", "Subscription_ID":1, "Tags":[ "10users" ], "License_ID":1, "Invalid":false, "Expired":false, "Billing_Cycle":{ "value":1, "type":"Monthly" }, "Description":"10 Users per month / 100", "Tenant_ID":"eu-west-1:00000000-0000-0000-0000-000000000000" } ]'
-  		else
-        url = "#@baseURL#@product_id/subscriptioninfo/#{account_id}?key=#@key"
-        response = HTTP.get(url).body
-        "#{response}"
-  		end  		
-  	end
-
-  	# Get Information of a license created
-  	def get_license_information(license_id, license_token)
-  		# When test is true
-  		if(@isTest)
-  			'{ "Name":"License Name", "Cost":{ "value":"100", "currency":"USD" }, "Tags":[ "10 User Package" ], "License_ID":1, "Product_ID":1, "Description":"10 Users per month / 100", "Billing_Cycle":{ "value":1, "type":"Monthly" }, "Metadata":"{\"users\":\"10\"}" }'
-  		else
-  			url = "#@baseURL#@product_id/license/#{license_id}/getlicensefromapi?key=#{license_token}"
-        response = HTTP.get(url).body
-        "#{response}"
-  		end  		
-  	end
-
-  	# Renew an Existing subscription
-  	def renew_subscription(subscription_id, new_license_id)
-  		# When test is true
-  		if(@isTest)
-  			'{ "Date":"01/01/2016", "Cost":{ "value":"100", "currency":"USD" }, "Name":"5 Users Plan", "Product_ID":1, "Customer_ID":1, "Customer_Name":"Customer Name", "Account_ID":"123456", "Metadata":"{\"users\":\"10 users\"}", "Subscription_ID":1, "Tags":[ "10users" ], "License_ID":1, "Invalid":false, "Expired":false, "Billing_Cycle":{ "value":1, "type":"Monthly" }, "Description":"10 Users per month / 100", "Tenant_ID":"eu-west-1:00000000-0000-0000-0000-000000000000" }'
-  		else
-        url = "#@baseURL#@product_id/subscription/#{subscription_id}/apiRenewSubscription/#{new_license_id}?key=#@key"
-        response = HTTP.get(url).body
-        "#{response}"
-  		end  		
-  	end
-
-
-  	# Get all the Licenses of the current product
-  	def get_all_licenses_of_product()
-  		# When test is true
-  		if(@isTest)
-  			'[{"Name":"License Name","Cost":{"value":"10","currency":"USD"},"Tags":["free","test","trial"],"License_ID":1,"Product_ID":1,"Description":"Test","Billing_Cycle":{"value":1,"type":"Monthly"},"Metadata":"{}"}]'
-  		else
-        url = "#@baseURL#@product_id/license/all?key=#@key"
-        response = HTTP.get(url).body
-        "#{response}"
-  		end  		
-  	end
-
-  	# Get the payment transactions for an account
-  	def get_account_payments(account_id)
-  		# When test is true
-  		if(@isTest)
-  			'[ { "Amount":"100", "Created_At":"1474872974062", "Currency":"USD", "Product_ID":1, "PayPal_Transaction":"PAY-11111111111", "Updated_At":"1474872974062", "Account_ID":"local", "PayPal_Payer_ID":"111111", "Subscription_ID":1, "Payment_Processed":true, "Payout_ID":"12345", "Payment_Sent":true, "PayPal_Payment_ID":"PAY-11111111111" } ]'
-  		else
-  		  url = "#@baseURL#@product_id/account/#{account_id}/transactions?key=#@key"
-        response = HTTP.get(url).body
-        "#{response}"
-  		end  		
-  	end
-
-  	# Get payment URL
-  	def get_payment_url(account_id, redirect)
-  		"#@appDir"+"payment.html?redirect=#{redirect}&productID=#@product_id&accountID=#{account_id}&key=#@key"
-   	end
-
-  	def get_obj
-  		"product_id = #@product_id , token = #@key , isTest = #@isTest"
-  	end
-
-  end
-end

data/lib/earnshark_sdk/version.rb

@@ -1,3 +0,0 @@
-module EarnsharkSdk
-  VERSION = "0.1.0"
-end