DV_RUBY_SDK 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89124d1b6c4b510d6c8bea95c6a2d5e212ff40fb
-  data.tar.gz: cd13b21bb5961fc6716f62dd27826dee727b98db
+  metadata.gz: 18ff3ef0499f06ade6e8cae10341accc4ac5c5c9
+  data.tar.gz: b7c799f1df0614c4ebe97e3de1f98c630cbe85bc
 SHA512:
-  metadata.gz: 3acc4e35faf2fac19cc4941d77f3508bfaba1046db2d7acedcf72d7e3bb275a6e47fd84e75c140eac9e2844702e551fe1cdda2041380ad0fb62c3df7889e2200
-  data.tar.gz: 47f4cbe5326eb92930400aab6c2a60cc9d5a58530cdd6e029f6c7e75b4e6427414c49e9b3063b8e16f4896062a35744cfd54ce3dc224b7cb21eadea311e6340a
+  metadata.gz: 47320728839008cdda71d8b5ecfb34ce7c952c96ebca831a742ea78b9c5daa14fb705058778cf83b7d336e67f56f13eb128b421a69e3f984078532d4d6b53512
+  data.tar.gz: 4b202ffcb0696d5aeeea58cc12793a67e329cb4612ca839536dddac4215839f56833699b18987490327ec9e97f66e7fb399a5bb86071e1e775645da7bfa16997

data/README.md

@@ -2,7 +2,7 @@
 
 Official Devless Ruby SDK
 
-##Official Documentation
+## Official Documentation
 
 Refer to https://docs.devless.io for a detailed documentation.
 
@@ -24,29 +24,27 @@ Or install it yourself as:
 
 ## Usage
 
-#Setup your Devless credentials
-If you are using rails you may create an file under RAILS_ROOT/config/initializers and put these setting there.
+### Setup your DevLess credentials
+If you are using rails you may create a new file called devless.rb in the config/initializers folder and set it up with your credentials this way
 
 ```ruby
 DVRUBYSDK.token = "52babb518f716ea9014baeb42926b9f9"
-DVRUBYSDK.url = "http://example.com"
-DVRUBYSDK.port = "8000"
+DVRUBYSDK.url = "http://myapp.herokuapp.com"
 ```
 
-For Ruby
+For  a normal Ruby script just follow this procedure
 
 ```ruby
 require "DV_RUBY_SDK"
 DVRUBYSDK.token = "52babb518f716ea9014baeb42926b9f9"
-DVRUBYSDK.url = "http://localhost"
-DVRUBYSDK.port = "8000"
+DVRUBYSDK.url = "http://myapp.herokuapp.com"
 ```
-#Create an instance of the Devless class to have access to the methods
+### Create an instance of the DevLess class to have access to the methods
 
 ```ruby
 @devless = DVRUBYSDK::Devless.new
 ```
-#To add data to table
+### To add data to table
 
 ```ruby
 data = {:name => "Tsatsu"}
@@ -54,14 +52,14 @@ results = @devless.add_data("service_name", "service_table", data)
 puts results
 ```
 
-#To query data from table
+### To query data from table
 
 ```ruby
 results = @devless.query_data("service_name", "service_table")
 puts results
 ```
 
-#Also you may filter your query with:
+### Also you may filter your query with:
 
 ``size:`` determine the number of results to return
 
@@ -92,7 +90,7 @@ results = @devless.orderBy("name").query_data("service_name", "service_table")
 puts results
 ```
 
-#To update data in table
+### To update data in table
 
 ```ruby
 data = {:name => "Edwin"}
@@ -100,27 +98,217 @@ results = @devless.where("id", 1).update_data("service_name", "service_table", d
 puts results
 ```
 
-#To delete data from table
+### To delete data from table
 
 ```ruby
 results = @devless.where("id", 1).delete_data("service_name", "service_table")
 puts results
 ```
 
-#Make a call to an Action Class in the Devless instance
+### Make a call to an Action Class in the DevLess instance
 
 ```ruby
 results = @devless.method_call("service_name", "method_name", {})
 puts results
 ```
 
-#Authenticating with a Devless instance
+### Authentication! DevLess comes with authentication baked in. You can access the authentication methods using the DevLess SDK
+#### NB: The five methods below require a user token to be set on the header for successful communicatiion with the DevLess backend. 
 
+#### Sign In
+
+```ruby
+results = @devless.method_call("devless", "login", {:email => "k@gmail.com", :password => "password"})
+user_token = JSON.parse(results)['payload']['result']['token']
+@devless.set_user_token(user_token);
+```
+Options available are 'username', 'email' & 'phone_number'.
+
+#### Sign Up
 ```ruby
-user_token = @devless.method_call("dvauth", "login", {:email => "k@gmail.com", :password => "password"});
-user_token = JSON.parse(user_token)
+results = @devless.method_call("devless", "signUp", {
+  :email        => "k@gmail.com", 
+  :password     => "password", 
+  :username     => "ironman",
+  :phone_number => "+233245632353",
+  :first_name   => "Tony",
+  :last_name    => "Stark",
+})
+user_token = JSON.parse(results)['payload']['result']['token']
 @devless.set_user_token(user_token);
 ```
+Options available to set the status & role of accounts.
+
+#### Updating Profile
+```ruby
+results = @devless.method_call("devless", "updateProfile", {
+  :email        => "avenger@gmail.com", 
+  :password     => "dontangryme", 
+  :username     => "hulk",
+  :phone_number => "+233204432432",
+  :first_name   => "Bruce",
+  :last_name    => "Banner",
+})
+puts results
+```
+
+#### Retrieving Profile
+```ruby
+results = @devless.method_call("devless", "profile", {})
+puts results
+```
+
+#### Log Out
+```ruby
+results = @devless.method_call("devless", "logout", {})
+puts results
+```
+
+## Full Rails Example
+### DEVLESS RAILS EXAMPLE (THE WHOLE PROCESS)
+
+## Step One
+Create a rails app from your terminal and name it anything I will call mine "devless"
+```
+$ rails new devless
+```
+Navigate into the folder from terminal and run bundle
+```
+$ bundle
+```
+
+## Step Two
+Add The 'DV_RUBY_SDK' gem by going into your gem file and pasting this code
+```Ruby
+  gem 'DV_RUBY_SDK'
+```
+
+Go back to your console and run bundle install
+```
+$ bundle install
+```
+
+Create a controller with an action in my case I will create a controller called devless with an index action. This is how I will do it.
+
+```
+$ rails g controller devless index
+```
+
+## Step Three
+#### Navigate to your config folder in the root and look for a folder called initializers. Create a file called devless.rb to configure devless. This the src config/initializers/devless.rb. You will need a token and a url to configure
+
+##### You will see your {token} and the app {url} in the app section of the devless app you created on  hosted on heroku. Click on the app tab and on your left and  just scroll down on your right you will see the token copy it.
+##### Url: Just copy the root of the devless app you created and hosted on heroku
+
+In my case my token is "7740b4b2303e32957a3215c344b8c21c" and my url is "http://newerapper.herokuapp.com" so since i have these can configure.
+
+
+#### Go to config/initializers/devless.rb and paste this code (Use your token and url not this)
+```Ruby
+  DVRUBYSDK.token = "7740b4b2303e32957a3215c344b8c21c"
+  DVRUBYSDK.url   = "http://newerapper.herokuapp.com"
+```
+
+## Step Four
+Navigate to app/controller and let's write some logic in the controller we created so we can post and query data on our devless backend. Copy and paste this code in the index action of your controller or you can also paste it in any action in your controller. Please read the comments to see what you have to do to customize it well.
+
+```Ruby
+  #create an instance of the devless class and assign it to a varibale.
+  # I will call mine *@devless* but you could call yours anything.
+
+  @devless = DVRUBYSDK::Devless.new
+
+  #At this stage we can query data, post data, patch and do what ever we want to our table from here
+  #Lets first query data
+  service_name = "names"
+  table_name = "eit_names"
+  @query_response = @devless.query_data(service_name, table_name)
+
+  #lets post data to that same table called "eit_names" which require one field ie "name"
+  @data_we_want_to_post = {name: "Charles"}
+  @post_data_response = devless.add_data(service_name, table_name, data_we_want_to_post)
+```
+## Step Five
+Access your data from the view or wherever you want to use it. So lets go to our view for the controller ie views/devless/index.html.erb in our case and paste this code and that is it!! Easy!
+```Rails
+  <%= @query_response %>
+  <%= @post_data_response %>
+```
+
+This is It you can do whatever you want with it read more methods in the sdk documentation. It is super easy, fast and efficient. Tell your friends about devless.
+
+ If you already have this just download this project from the eamples folder and run bundle install on your local change the config/initializers/devless.rb and start using it. happy coding!!. Welcome to Devless
+
+
+## Full ruby example
+  ```Ruby
+  =begin
+  step One Run gem install DV_RUBY_SDK
+  step two create a .rb file and call it anything. I have called mine devless.rb in this instance
+
+  Agenda
+  -------
+
+  We want to do a simple post and query from one of the tables in my service on my devless
+  panel(the one I am hosting on heroku)
+  The service name is called "names" and under this service I have a table called eit_names
+  with one field called "name" which is a string
+
+  service name = "names"
+  table_name = "eit_names"
+  let's do this!
+  =end
+
+  #require the gem
+  require "DV_RUBY_SDK"
+
+  =begin
+  set it up with your credentials. you will need these two credentials {token}
+  token can be found in the app tab on your devless panel where you created your services
+  copy the token.
+  my token  = "7740b4b2303e32957a3215c344b8c21c"
+  You will also need the {url} ie the url of the devless app you created
+  (in my case the one I created and hosted on heroku)
+  my_app_url = "http://newerapper.herokuapp.com"
+  If you have these two you can set up
+  set it up this way
+  =end
+
+  my_token = "7740b4b2303e32957a3215c344b8c21c"
+  my_app_url =  "http://newerapper.herokuapp.com"
+
+  DVRUBYSDK.token = my_token
+  DVRUBYSDK.url   = my_app_url
+
+  #create an intance of the devless class and assign it to a varibale.
+  # I will call mine *devless* you could call yours anything.
+
+  devless = DVRUBYSDK::Devless.new
+
+  #at this stage we can query data, post data, patch and do what ever we want to our table from here
+  #lets first query data
+
+  service_name = "names"
+  table_name = "eit_names"
+
+  query_response = devless.query_data(service_name, table_name)
+  puts query_response
+
+
+  #lets post data to that same table called "eit_names" which require one field ie "name"
+  data_we_want_to_post = {name: "Charles"}
+  post_data_response = devless.add_data(service_name, table_name, data_we_want_to_post)
+  puts post_data_response
+
+  =begin
+  Run it by pressing command b on your sublime if youre on a mac or run the script in your terminal if otherwise.
+  You should see data returned without any errors and when you check back in your table
+  you will see a new entry in your database.
+  Thats how fast, poowerful; and easy devless has made things
+  Tell your friends about devless. Thanks
+  =end
+
+  ```
 
 ## Contributing
 

data/examples/rails/devless/.gitignore

@@ -0,0 +1,21 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history

data/examples/rails/devless/Gemfile

@@ -0,0 +1,55 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 5.0.2'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use Puma as the app server
+gem 'puma', '~> 3.0'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 5.0'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .coffee assets and views
+gem 'coffee-rails', '~> 4.2'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
+gem 'turbolinks', '~> 5'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.5'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 3.0'
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+gem 'DV_RUBY_SDK'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platform: :mri
+end
+
+group :development do
+  # Access an IRB console on exception pages or by using <%= console %> anywhere in the code.
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '~> 3.0.5'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/examples/rails/devless/Gemfile.lock

@@ -0,0 +1,176 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    DV_RUBY_SDK (1.0.1)
+    actioncable (5.0.2)
+      actionpack (= 5.0.2)
+      nio4r (>= 1.2, < 3.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.2)
+      activesupport (= 5.0.2)
+      globalid (>= 0.3.6)
+    activemodel (5.0.2)
+      activesupport (= 5.0.2)
+    activerecord (5.0.2)
+      activemodel (= 5.0.2)
+      activesupport (= 5.0.2)
+      arel (~> 7.0)
+    activesupport (5.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.4)
+    bindex (0.5.0)
+    builder (3.2.3)
+    byebug (9.0.6)
+    coffee-rails (4.2.1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.2.x)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.12.2)
+    concurrent-ruby (1.0.5)
+    erubis (2.7.0)
+    execjs (2.7.0)
+    ffi (1.9.18)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.8.1)
+    jbuilder (2.6.3)
+      activesupport (>= 3.0.0, < 5.2)
+      multi_json (~> 1.2)
+    jquery-rails (4.3.1)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    multi_json (1.12.1)
+    nio4r (2.0.0)
+    nokogiri (1.7.1)
+      mini_portile2 (~> 2.1.0)
+    puma (3.8.2)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.2)
+      actioncable (= 5.0.2)
+      actionmailer (= 5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      activemodel (= 5.0.2)
+      activerecord (= 5.0.2)
+      activesupport (= 5.0.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.8)
+      ffi (>= 0.5.0)
+    sass (3.4.23)
+    sass-rails (5.0.6)
+      railties (>= 4.0.0, < 6)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (>= 1.1, < 3)
+    spring (2.0.1)
+      activesupport (>= 4.2)
+    spring-watcher-listen (2.0.1)
+      listen (>= 2.7, < 4.0)
+      spring (>= 1.2, < 3.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tilt (2.0.7)
+    turbolinks (5.0.1)
+      turbolinks-source (~> 5)
+    turbolinks-source (5.0.0)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    uglifier (3.2.0)
+      execjs (>= 0.3.0, < 3)
+    web-console (3.5.0)
+      actionview (>= 5.0)
+      activemodel (>= 5.0)
+      bindex (>= 0.4.0)
+      railties (>= 5.0)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  DV_RUBY_SDK
+  byebug
+  coffee-rails (~> 4.2)
+  jbuilder (~> 2.5)
+  jquery-rails
+  listen (~> 3.0.5)
+  puma (~> 3.0)
+  rails (~> 5.0.2)
+  sass-rails (~> 5.0)
+  spring
+  spring-watcher-listen (~> 2.0.0)
+  sqlite3
+  turbolinks (~> 5)
+  tzinfo-data
+  uglifier (>= 1.3.0)
+  web-console (>= 3.3.0)
+
+BUNDLED WITH
+   1.14.4