ncmb_rb_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb46478908205c729ce5b4170c9f86e14dbc791c
+  data.tar.gz: e2c326396b9a13dbfec20d362d37dc883c9732d0
+SHA512:
+  metadata.gz: 98b16d1c5b9261d3e4c8a3e55ea3058448c6780b60bb37ca96e57b065c1f30cdb9d59e35c5d7c37dc3ec58f9c8af55538e67679943752210c875132a1dfd6a5a
+  data.tar.gz: 7b7587e86443f0dc4737ee7b96c5ba1fad9ec21a81900ee2be7d21cc4138c89d472c9a39d5e76d89bdf7ebfd36706d39b6e62df6c9d9c04f43f959514174570f

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/.idea/
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ncmb_rb_wrapper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Yuta Suzuki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# ncmb_rb_wrapper
+Ruby wrapper for NIFTY Cloud mobile backend REST API.
+
+#### [NIFTY Cloud mobile backend](http://mb.cloud.nifty.com/)
+- Free for Basic Plan
+- 2,000,000 API requests/month
+- 2,000,000 Push Notifications/month
+- 5GB Object Storage
+- [And more...](http://mb.cloud.nifty.com/price.htm)
+
+
+## Installation
+Add to Gemlist
+```ruby:Gemfile
+gem 'ncmb_rb_wrapper', :github => 'yutaszk/ncmb_rb_wrapper'
+```
+
+
+## Usage
+### RestClient
+Client class wrap API request.
+Please refer to [REST API Reference](http://mb.cloud.nifty.com/doc/current/rest/common/format.html)
+```ruby
+@ncmb = Ncmb::Client.new(application_key, client_key)
+@ncmb.get("/classes/app/") #=> all object in 'App' class
+```
+
+### DataStore
+```ruby
+@app = Ncmb::DataStore.new(application_key, client_key, 'App')
+@app.post({foo: :bar})
+@app.get(id}
+@app.put(id, {foo: :baz})
+@app.delete(id)
+@app.all()
+@app.search(where: {foo: :bar})
+@app.where({foo: :bar})
+@app.batch_post([{foo: :bar}, {one: 1, two:2}])
+@app.batch_put([{id: ID, query: {foo: baz}, {id: ID, query: {one: :first}])
+@app.batch_delete([ID, ID])
+```
+
+or call method with class name
+```ruby
+@ds = Ncmb::DataStore.new(pplication_key, client_key)
+@ds.post({foo: :bar}, 'App)
+```
+
+### FileStore
+lease refer to [REST API File Store Reference](http://mb.cloud.nifty.com/doc/current/rest/filestore/fileRegistration.html)
+```ruby
+@fs = Ncmb::FileStore.new(application_key, client_key)
+@fs.post(file, acl)
+@fs.get(name) #=> binary
+@fs.delete(name)
+@fs.all()
+@fs.where({fileName: :hoge)
+
+#TODO: @fs.put(name, acl)
+#TODO: @fs.public_file(name, application_id)
+```
+
+or call file method by Ncmb::Client object
+```ruby
+@ncmb.file.post(file, acl)
+```
+
+### Ruby Friendly Sugar Syntax
+```ruby
+@app.find #=> search
+@app.save #=> post
+@app.update #=> put
+@app.destroy #=> delete
+```
+
+## Supported
+ruby 2.0+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ncmb_rb_wrapper"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ncmb_rb_wrapper/version.rb

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

data/lib/ncmb_rb_wrapper.rb

@@ -0,0 +1,314 @@
+require 'time'
+require 'uri'
+require 'openssl'
+require 'base64'
+require 'net/http'
+require 'net/http/post/multipart'
+require 'json'
+require 'mimemagic'
+
+module Ncmb
+  class Client
+    def initialize(application_key, client_key)
+      @application_key = application_key
+      @client_key = client_key
+      @api_version = '2013-09-01'
+      @domain = 'mb.api.cloud.nifty.com'
+    end
+
+    def get(path, hash_query = {})
+      request(:GET, path, hash_query)
+    end
+
+    def post(path, hash_query = {})
+      request(:POST, path, hash_query)
+    end
+
+    def put(path, hash_query = {})
+      request(:PUT, path, hash_query)
+    end
+
+    def delete(path)
+      request(:DELETE, path)
+    end
+
+    def batch(array_request)
+      request(:POST, '/batch', requests: array_request)
+    end
+
+    def file
+      FileStore.new(@application_key, @client_key)
+    end
+
+    def data(klass = nil)
+      if klass.nil?
+        DataStore.new(@application_key, @client_key)
+      else
+        DataStore.new(@application_key, @client_key, klass)
+      end
+    end
+
+    private
+    def request(method, path, hash_query = {})
+      http = Net::HTTP.new(@domain, 443)
+      http.use_ssl = true
+
+      path = "/#{@api_version}#{path}"
+      current_time = Time.now.utc.iso8601
+      signature = sign(method, hash_query, path, current_time)
+
+      if block_given?
+        yield(http, path, current_time, signature)
+      else
+        case method
+        when :GET
+          query = URI.encode_www_form(hash_query.map { |k, v| [k, v.to_json] })
+          path = "#{path}?#{query}"
+          res = http.get(path, header(signature, current_time))
+          JSON.parse(res.body)
+        when :POST
+          res = http.post(path, hash_query.to_json, header(signature, current_time))
+          JSON.parse(res.body)
+        when :PUT
+          res = http.put(path, hash_query.to_json, header(signature, current_time))
+          JSON.parse(res.body)
+        when :DELETE
+          res = http.delete(path, header(signature, current_time))
+          'successfully deleted.' if res.code == "200"
+        else
+          raise Exception 'undefined method.'
+        end
+      end
+    # rescue => e
+    #   puts e
+    end
+
+    def sign(method, hash_query, path, current_time)
+      hash = {
+        'SignatureMethod' => 'HmacSHA256',
+        'SignatureVersion' => 2,
+        'X-NCMB-Application-Key' => @application_key,
+        'X-NCMB-Timestamp' => current_time
+      }
+
+      if method == :GET
+        hash_query.each do |key, value|
+          hash.store(key.to_s, URI.encode_www_form_component(value.to_json))
+        end
+      end
+      hash = Hash[hash.sort]
+      chained_param = hash.map { |k, v| "#{k}=#{v}" }.join('&')
+      base_param = [method, @domain, path, chained_param].join("\n")
+      signature = Base64.encode64(OpenSSL::HMAC::digest('sha256', @client_key, base_param))
+    end
+
+    def header(signature, current_time, content_type = 'application/json')
+      {
+        'X-NCMB-Application-Key' => @application_key,
+        'X-NCMB-Signature' => signature,
+        'X-NCMB-Timestamp' => current_time,
+        'Content-Type' => content_type,
+      }
+    end
+  end
+
+  class DataStore < Client
+    alias :super_get :get
+
+    def initialize(application_key, client_key, klass = nil)
+      @klass = klass
+      super(application_key, client_key)
+    end
+
+    # # #
+    # DataStore method
+
+    def post(hash_query = {}, klass = @klass)
+      validate_klass klass
+      super("/classes/#{klass}", hash_query)
+    end
+
+    def get(id, klass = @klass)
+      validate_klass klass
+      super("/classes/#{klass}/#{id}")
+    end
+
+    def put(id, hash_query, klass = @klass)
+      validate_klass klass
+      super("/classes/#{klass}/#{id}", hash_query)
+    end
+
+    def delete(id, klass = @klass)
+      validate_klass klass
+      super("/classes/#{klass}/#{id}")
+    end
+
+    def all(klass = @klass)
+      validate_klass klass
+      super_get("/classes/#{klass}")
+    end
+
+    def where(hash_query, klass = @klass)
+      validate_klass klass
+      super_get("/classes/#{klass}", where: hash_query)
+    end
+
+    def search(hash_query = {}, klass = @klass)
+      validate_klass klass
+      super_get("/classes/#{klass}", hash_query)
+    end
+
+    # ##
+    # syntax sugar
+
+    # syntax sugar of search
+    def find(hash_query = {}, klass = @klass)
+      search(hash_query, klass)
+    end
+
+    # syntax sugar of post
+    def save(hash_query = {}, klass = @klass)
+      post(hash_query, klass)
+    end
+
+    # syntax sugar of put
+    def update(id, hash_query, klass = @klass)
+      put(id, hash_query, klass)
+    end
+
+    # syntax sugar of delete
+    def destroy(id, klass = @klass)
+      delete(id, klass)
+    end
+
+    # # #
+    # batch method
+
+    # array_query = [
+    #   {foo: :bar},
+    #   {hoge: :fuga}
+    # ]
+    def batch_post(array_query)
+      validate_klass @klass
+      array_request = array_query.map do |query|
+        {
+          method: :POST,
+          path: "#{@api_version}/classes/#{@klass}",
+          body: query
+        }
+      end
+      batch_response batch(array_request)
+    end
+
+    # array_query = [
+    #   {id: 'XXXXXXXX', query: {foo: :baz}},
+    #   {id: 'YYYYYYYY', query: {hoge: :piyo}}
+    # ]
+    # array_query = [
+    #   ['XXXXXXXX', {foo: :baz}],
+    #   ['YYYYYYYY', {hoge: :piyo}}
+    # ]
+    def batch_put(array_query)
+      validate_klass @klass
+      array_request = array_query.map do |obj|
+        case obj
+        when Array
+          {
+            method: :PUT,
+            path: "#{@api_version}/classes/#{@klass}/#{obj[0]}",
+            body: obj[1]
+          }
+        when Hash
+          {
+            method: :PUT,
+            path: "#{@api_version}/classes/#{@klass}/#{obj[:id]}",
+            body: obj[:query]
+          }
+        else
+          {}
+        end
+      end
+      batch_response batch(array_request)
+    end
+
+    # array_query = [
+    #   'XXXXXXXX',
+    #   'YYYYYYYY'
+    # ]
+    def batch_delete(array_query)
+      validate_klass @klass
+      array_request = array_query.map do |id|
+        {
+          method: :DELETE,
+          path: "#{@api_version}/classes/#{@klass}/#{id}",
+          body: {}
+        }
+      end
+      batch_response batch(array_request)
+    end
+
+    private
+    def validate_klass(klass)
+      raise 'NCMB DataStore Class Name is undefined.' if klass.nil?
+    end
+
+    def batch_response(res)
+      def res.success
+        self.map { |r| r['success'] }.compact
+      end
+
+      def res.error
+        self.map { |r| r['error'] }.compact
+      end
+
+      return res
+    end
+  end
+
+  class FileStore < Client
+    alias :super_get :get
+
+    def post(file, acl = {})
+      name = File.basename(file)
+      path = "/files/#{name}"
+      request(:POST, path, acl) { |http, path, current_time, signature|
+        req = Net::HTTP::Post::Multipart.new(
+          path, {file: UploadIO.new(file, MimeMagic.by_path(name).to_s)},
+          header(signature, current_time, 'multipart/form-data')
+        )
+        res = http.request(req)
+        JSON.parse(res.body)
+      }
+    end
+
+    def get(name)
+      path = "/files/#{name}"
+      request(:GET, path) { |http, path, current_time, signature|
+        res = http.get(path, header(signature, current_time))
+        res.body
+      }
+    end
+
+    def put(name, acl)
+      super("/files/#{name}/", acl: acl)
+    end
+
+    def delete(name)
+      super("/files/#{name}")
+    end
+
+    def all
+      super_get('/files')
+    end
+
+    # noinspection RubyArgCount
+    def where(hash_query)
+      super_get('/files', where: hash_query)
+    end
+
+    # noinspection RubyArgCount
+    def search(hash_query = {})
+      super_get('/files', hash_query)
+    end
+  end
+end

data/ncmb_rb_wrapper.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ncmb_rb_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ncmb_rb_wrapper"
+  spec.version       = Ncmb::VERSION
+  spec.authors       = ['yutaszk']
+  spec.email         = ['yutaszk@gmail.com']
+
+  spec.description   = 'API wrapper for NIFTY Cloud mobile backend'
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/yutaszk"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "rspec", "~> 3.0"
+  spec.add_dependency "multipart-post", "~> 2.0"
+  spec.add_dependency "mimemagic", "~> 0.3.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: ncmb_rb_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yutaszk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: API wrapper for NIFTY Cloud mobile backend
+email:
+- yutaszk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ncmb_rb_wrapper.rb
+- lib/ncmb_rb_wrapper/version.rb
+- ncmb_rb_wrapper.gemspec
+homepage: https://github.com/yutaszk
+licenses:
+- MIT
+metadata: {}
+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.4.5
+signing_key: 
+specification_version: 4
+summary: API wrapper for NIFTY Cloud mobile backend
+test_files: []