ncmb-ruby-client 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e65e1b5191a72496c2e4a2e9d8ab68c763c2ed8a
-  data.tar.gz: 68d517fcc314a76e414fd7aa7c102620c3354b0a
+SHA256:
+  metadata.gz: 325cb5e8ea166ccd9c833479bf76b39cb808d960732ade4362b98c853c3e93dc
+  data.tar.gz: 9d416ff772a6be5ed268b644dd9e21b6d727d564d2fa453164604ac755d4c9ff
 SHA512:
-  metadata.gz: 023b10a8a2fc0e80b599bfea180b8f702fd10ec18a6365512ff30e3f321d673494ceed1a9bb82194b8cb2a0e4273be8c428e99ca3a7e56a785979b42b89b92a3
-  data.tar.gz: 091f60a5952d5d34c1dfcc04bdac6cb463cf1fd08a8fde9c596c17344b72de396675dee5ad4f1e6f830e683f116f04bc7b6aa7c289f88b303b2310434dac5d11
+  metadata.gz: a4ff1e970aa5f31b78a48d92a6ac5b18fa64a926e724a9c1cd7675180c8e31a06ef37447c611e59f079940d885e8610fb996b0c2d5d6f22efc53f5dd14075167
+  data.tar.gz: 67fd00eb2d8d924e5b8d07c4cdda94753b9f8b61166b65dc31e2c705d23592f63cd3f68ae17ff73e0ae0a71d3289c809b4bce0aef758d1b2f2851fc2bb0b0309

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 tmp
 setting.yml
 .DS_Store
+vendor/

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.3

data/Gemfile

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
+
+gem 'mime-types'
 gem 'simplecov'
 gem 'simplecov-gem-profile'
-gem 'mime-types'
 # Specify your gem's dependencies in ncmb-ruby-client.gemspec
 gemspec

data/README.md

@@ -1,7 +1,7 @@
 ncmb-ruby-client
 ================
 
-A simple Ruby client for the nifty cloud mobile backend REST API
+A simple Ruby client for the nifty cloud mobile backend REST API. This is developer preview.
 
 Basic Usage
 -----------
@@ -47,4 +47,109 @@ else
 end
 ```
 
-[ニフティクラウド mobile backend](http://mb.cloud.nifty.com/)
+## Unit test
+
+### Settings
+* Install libraries
+```
+bundle install
+```
+* Rename file `setting_default.yml` to `setting.yml` and then fill you `application_key`, `client_key`
+
+### Run unit test 
+Run `spec` task:
+```
+rake spec
+```
+
+## Run all examples
+
+Run `examples` task:
+
+```
+rake examples
+```
+
+Or you can run every single example
+
+```
+ruby examples/example_file_name.rb
+```
+
+## Test script
+
+Before run `examples/script.rb`, you should upload the below script files to Script function on the Console screen.
+
+### helloworld.js
+
+* File Name: helloworld.js
+* Method: GET
+* File Status: Executable
+```javascript
+module.exports = function(req, res) {
+  res.send('{"msg":"Hello World!"}');
+}
+```
+
+### helloworld2.js
+
+* File Name: helloworld2.js
+* Method: GET
+* File Status: Executable
+```javascript
+module.exports = function(req, res) {
+  if (req.query.name) {
+    res.send('{"msg":"Hello ' + req.query.name +'!"}');
+  } else {
+    res.send('{"msg":"Hello World!"}');
+  }
+}
+```
+
+### email.js
+
+* File Name: email.js
+* Method: POST
+* File Status: Executable
+
+(Don't forget to change `YOUR-APPLICATION-KEY` and `YOUR-CLIENT-KEY` to your value before upload.)
+
+```javascript
+function saveData(req, res) {
+  // POSTのデータを取得
+  var email = req.body.email;
+  var message = req.body.body;
+  
+  var NCMB = require('ncmb');
+  var ncmb = new NCMB('YOUR-APPLICATION-KEY', 'YOUR-CLIENT-KEY');
+
+  // データを保存する
+  var Item = ncmb.DataStore('Item');
+  var item = new Item();
+  item.set("email", email)
+      .set("message", message)
+      .save()
+      .then(function(item){
+        // 成功
+        res.send('{"msg":"POST data successfully!"}');
+
+      })
+      .catch(function(err){
+        // 失敗
+        res.send('{"msg":"' + err + '"}');
+      });
+}
+
+module.exports = saveData;
+```
+
+## Environment to confirm
+
+* Ruby v2.7.3 - Bundler version 2.1.4
+* Ruby v3.0.1 - Bundler version 2.2.15
+
+## License
+
+MIT.
+
+[ニフクラ mobile backend](https://mbaas.nifcloud.com/)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
 Bundler.setup
@@ -6,4 +8,8 @@ require 'rspec/core/rake_task'
 desc "run spec"
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = ["--color", "--format documentation"]
+end
+
+task :examples do
+  FileList['examples/*.rb'].each { |file| ruby file }
 end

data/examples/acl_test.rb

@@ -1,16 +1,22 @@
-$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$:.unshift(File.dirname(__FILE__))
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'rubygems'
 require 'ncmb'
 require 'yaml'
 yaml = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'setting.yml'))
-NCMB.initialize application_key: yaml['application_key'],  client_key: yaml['client_key']
+NCMB.initialize(
+  application_key: yaml['application_key'],
+  client_key: yaml['client_key']
+)
 
 @users = []
 
 @ids = [
-  {id: 'testUser1', password: 'testPassword1'},
-  {id: 'testUser2', password: 'testPassword2'}
+  { id: 'testUser1', password: 'testPassword1' },
+  { id: 'testUser2', password: 'testPassword2' }
 ]
 @ids.each do |hash|
   @user = NCMB::User.login(hash[:id], hash[:password])
@@ -37,7 +43,7 @@ end
 @item.acl.public('write', false)
 @item.acl.user(@users[0], 'read', true)
 @item.acl.user(@users[0], 'write', true)
-@role = NCMB::Role.find_or_create("manager2")
+@role = NCMB::Role.find_or_create('manager2')
 
 @item.acl.role(@role, 'read', true)
 @item.acl.role(@role, 'write', true)

data/examples/csv_test.rb

@@ -1,23 +1,32 @@
-$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$:.unshift(File.dirname(__FILE__))
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'rubygems'
 require 'ncmb'
 require 'yaml'
 require 'csv'
 
 yaml = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'setting.yml'))
-NCMB.initialize application_key: yaml['application_key'],  client_key: yaml['client_key']
+NCMB.initialize(
+  application_key: yaml['application_key'],
+  client_key: yaml['client_key']
+)
 @todo = NCMB::DataStore.new 'TestClass'
-1000.times do |i|
-  @todo.post(message: "Hello! #{i}")
+20.times do |i|
+  item = @todo.new
+  item.set('message', "Hello! #{i}")
+  item.save
 end
-@todos = @todo.limit(20).count(1).skip(0)
+
+@todos = @todo.limit(10).skip(0)
 
 csv_string = CSV.generate do |csv|
-  csv << @todos.first.columns
+  csv << @todos.first.fields.keys
   @todos.each do |todo|
     params = []
-    todo.columns.each do |name|
+    todo.fields.keys.each do |name|
       params << todo.call(name)
     end
     csv << params

data/examples/data_store.rb

@@ -1,10 +1,16 @@
-$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$:.unshift(File.dirname(__FILE__))
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'rubygems'
 require 'ncmb'
 require 'yaml'
 yaml = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'setting.yml'))
-NCMB.initialize application_key: yaml['application_key'],  client_key: yaml['client_key']
+NCMB.initialize(
+  application_key: yaml['application_key'],
+  client_key: yaml['client_key']
+)
 
 example = NCMB::DataStore.new 'Example'
 example.delete_all
@@ -14,7 +20,7 @@ example.delete_all
   item.set('String', "テスト#{i}00")
   item.set('Integer', i)
   item.set('Boolean', true)
-  item.set('Array', [i, i * 2, i * 3, "Orange", "Tomato"])
+  item.set('Array', [i, i * 2, i * 3, 'Orange', 'Tomato'])
   item.set('Object', {test1: 'a', test2: 'b'})
   item.set('Location', NCMB::GeoPoint.new((i + 1) * 10, (i + 2) * 5))
   item.set('MultipleLine', "test\ntest\n")
@@ -37,7 +43,8 @@ geo1 = NCMB::GeoPoint.new(50, 30);
 geo2 = NCMB::GeoPoint.new(51, 31);
 
 # @todo = @todo.limit(20).withinKilometers("Location", geo1, 1000)
-example = example.limit(1).withinSquare("Location", geo1, geo2)
+
+example = example.limit(1).withinSquare('Location', geo1, geo2)
 begin
   example.each_with_index do |item, i|
     puts item[:String]
@@ -50,6 +57,7 @@ begin
     # item.update
   end
 rescue NCMB::FetchError => e
+  puts e
   puts example.error
 end
 

data/examples/file_test.rb

@@ -1,30 +1,36 @@
-$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$:.unshift(File.dirname(__FILE__))
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'rubygems'
 require 'ncmb'
 require 'yaml'
 require 'open-uri'
 yaml = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'setting.yml'))
-NCMB.initialize application_key: yaml['application_key'],  client_key: yaml['client_key']
+NCMB.initialize(
+  application_key: yaml['application_key'],
+  client_key: yaml['client_key']
+)
 
-f = NCMB::NFile.new('http://mb.cloud.nifty.com/assets/images/logo.png')
+f = NCMB::NFile.new('https://mbaas.nifcloud.com/assets/images/logo.png')
 f.acl.public('read', true)
 f.acl.public('write', true)
-f.fileName = "test.png"
+f.fileName = 'test.png'
 f.save()
-puts "Uploaded"
+puts 'Uploaded'
 f.file = 'http://k.yimg.jp/images/top/sp2/cmn/logo-ns_d_131205.png'
 f.update()
-puts "Updated"
+puts 'Updated'
 f.delete()
-puts "Deleted"
+puts 'Deleted'
 
-f = NCMB::NFile.new('http://mb.cloud.nifty.com/assets/images/logo.png')
+f = NCMB::NFile.new('https://mbaas.nifcloud.com/assets/images/logo.png')
 f.acl.public('read', true)
 f.acl.public('write', true)
-f.fileName = "test.png"
+f.fileName = 'test.png'
 f.save()
-file = NCMB::NFile.new("test.png")
-fp = open("test.png", "w")
+file = NCMB::NFile.new('test.png')
+fp = open('test.png', 'w')
 fp.write(file.get)
 fp.close

data/examples/performance.rb

@@ -1,10 +1,16 @@
-$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$:.unshift(File.dirname(__FILE__))
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'rubygems'
 require 'ncmb'
 require 'yaml'
 yaml = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'setting.yml'))
-NCMB.initialize application_key: yaml['application_key'],  client_key: yaml['client_key']
+NCMB.initialize(
+  application_key: yaml['application_key'],
+  client_key: yaml['client_key']
+)
 
 example = NCMB::DataStore.new 'Example'
 
@@ -12,13 +18,13 @@ require 'benchmark'
 
 ary = []
 Benchmark.bm 10 do |r|
-  r.report "Save DataStore" do
+  r.report 'Save DataStore' do
     100.times do |i|
       item = example.new
       item.set('String', "テスト#{i}00")
       item.set('Integer', i)
       item.set('Boolean', true)
-      item.set('Array', [i, i * 2, i * 3, "Orange", "Tomato"])
+      item.set('Array', [i, i * 2, i * 3, 'Orange', 'Tomato'])
       item.set('Object', {test1: 'a', test2: 'b'})
       item.set('Location', NCMB::GeoPoint.new(30, 50))
       item.set('MultipleLine', "test\ntest\n")
@@ -28,7 +34,7 @@ Benchmark.bm 10 do |r|
       ary << item.objectId
     end
   end
-  r.report "Delete objects" do
+  r.report 'Delete objects' do
     ary.each do |objectId|
       item = example.new(objectId: objectId)
       item.delete

data/examples/pointer_test.rb

@@ -1,16 +1,22 @@
-$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$:.unshift(File.dirname(__FILE__))
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'rubygems'
 require 'ncmb'
 require 'yaml'
 yaml = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'setting.yml'))
-NCMB.initialize application_key: yaml['application_key'],  client_key: yaml['client_key']
+NCMB.initialize(
+  application_key: yaml['application_key'],
+  client_key: yaml['client_key']
+)
 
 Parent = NCMB::DataStore.new 'Parent'
 
 Child = NCMB::DataStore.new 'Child'
-child = Child.new(name: "Taro")
-parent = Parent.new(name: "Oya")
+child = Child.new(name: 'Taro')
+parent = Parent.new(name: 'Oya')
 parent.child = child
 parent.save
 

data/examples/push.rb

@@ -1,18 +1,24 @@
-$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$:.unshift(File.dirname(__FILE__))
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'rubygems'
 require 'ncmb'
 require 'yaml'
 yaml = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'setting.yml'))
-NCMB.initialize application_key: yaml['application_key'],  client_key: yaml['client_key']
+NCMB.initialize(
+  application_key: yaml['application_key'],
+  client_key: yaml['client_key']
+)
 
 @push = NCMB::Push.new
 @push.immediateDeliveryFlag = true
 @push.target = ['ios']
-@push.message = "This is test message"
-@push.deliveryExpirationTime = "3 day"
+@push.message = 'This is test message'
+@push.deliveryExpirationTime = '3 day'
 if @push.save
-  puts "Push save successful."
+  puts 'Push save successful.'
 else
-  puts "Push save faild."
+  puts 'Push save faild.'
 end