mind_meister_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0fc68e40add70b4b0e5e9a7ef1ce6c241c893cc5
+  data.tar.gz: ec3d39648ce2466c105b69fa0c4dee3afefe1c30
+SHA512:
+  metadata.gz: 1ca17f57879cc32210dbc53ecce416709d4a8eae8802895343c6be3429ff0d4b3982c36c44da3411aa5030aaf3df7dfddb3b82bcfe4e379332fe284767e17253
+  data.tar.gz: 3431383f4b731e75ccfefd0e34124abcf6423af43cf24dd1c228d3d23015a938a923020aba45e5a595190f34c82e91e444c572b04658246b1689f58a78a604c6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Mailo Svetel
+
+MIT License
+
+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,104 @@
+# Mind Meister Ruby client
+
+Client for API of web based and mobile mind mapping app -- [MindMeister](https://www.mindmeister.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mind_meister_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mind_meister_client
+
+## Usage
+
+I've maid one testing Rails app, and the usage was as follows.
+
+app/controllers/application_controller.rb
+~~~ruby
+  before_action :setup_mm_client
+
+  private
+
+  def setup_mm_client
+    @mm_client = MindMeisterClient::Requester.new '1625a1388f512a203faa43e8685bcdde',
+                                                  '2d845879a2f2a3b1'
+
+    @mm_client.auth_token= current_user.mm_auth_token if current_user
+  end
+~~~
+(current_user comes from [devise](https://github.com/plataformatec/devise))
+
+app/controllers/welcome_controller.rb
+
+~~~ruby
+def index
+  begin
+    @maps = @mm_client.maps_get_list
+  rescue MindMeisterClient::ApiCallRequiredError => e
+    redirect_to e.api_call_url
+  end
+
+end
+
+# MindMeister will point user to this url after successful authorization
+def callback
+  auth_data = @mm_client.callback params[:frob]
+
+  user = User.find_or_create_by email: auth_data[:auth][:user][:email] do |user|
+    user.mm_auth_token = auth_data[:auth][:token]
+    user.full_name = auth_data[:auth][:user][:fullname]
+  end
+
+  sign_in(:user, user)
+
+  redirect_to 'index'
+end
+~~~
+
+config/routes.rb
+~~~ruby
+root 'welcome#index'
+get 'welcome/callback'
+
+devise_for :users
+~~~
+
+app/views/welcome/index.html.erb
+~~~erb
+My maps
+
+<ul>
+  <% @maps[:maps][:map].each do |map_data| %>
+  <li><%= map_data[:title] %> (ID: <%= map_data[:id] %>)</li>
+  <% end %>
+</ul>
+~~~
+
+And also there was needed migration to adjust scheme for User model
+~~~ruby
+def change
+  change_table :users do |t|
+    t.column :mm_auth_token,  :string
+    t.column :full_name,      :string
+  end
+end
+~~~
+
+This implementation is very far from production-ready, but I hope it'll help as a quick start.
+
+## Contributing
+
+1. [Fork it](https://github.com/roolo/mind_meister_client/fork) ( https://github.com/roolo/mind_meister_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/mind_meister_client/api_call_required_error.rb

@@ -0,0 +1,29 @@
+module MindMeisterClient
+  class ApiCallRequiredError < Exception
+    attr_accessor :msg
+    attr_accessor :template
+    attr_accessor :api_call_url
+
+    # @param [String] msg
+    # @param [String] api_call_url
+    def initialize msg, api_call_url
+      @msg = msg
+      @api_call_url = api_call_url
+    end
+
+    def to_s
+      setup_template unless @template
+
+      data = {
+        api_call_url: @api_call_url,
+        msg: @msg
+      }
+
+      @template%data
+    end
+
+    def setup_template
+      @template = '%{msg}: %{api_call_url}'
+    end
+  end
+end

data/lib/mind_meister_client/request_error.rb

@@ -0,0 +1,57 @@
+module MindMeisterClient
+  class RequestError < Exception
+    # Object not found
+    MM_ERROR_OBJECT_NOT_FOUND = 20
+    # Well...
+    MM_ERROR_REQUIRED_PARAMETER_MISSING = 23
+    # The passed signature was invalid.
+    MM_ERROR_INVALID_SIGNATURE = 96
+    # The call required signing but no signature was sent.
+    MM_ERROR_MISSING_SIGNATURE = 97
+    # The login details or auth token passed were invalid.
+    MM_ERROR_LOGIN_FAILED = 98
+    # The API key passed was not valid or has expired.
+    MM_ERROR_INVALID_API_KEY = 100
+    # The specified frob does not exist or has already been used.
+    MM_ERROR_INVALID_FROB = 108
+    #The requested method was not found.
+    MM_ERROR_METHOD_NOT_FOUND = 112
+
+    attr_accessor :code
+    attr_accessor :msg
+    attr_accessor :provided_data
+    attr_accessor :template
+
+    # @param [String] code
+    # @param [String] msg
+    # @param [Hash] provided_data
+    def initialize code, msg, provided_data
+      @code = code
+      @msg = msg
+      @provided_data = provided_data
+    end
+
+    def to_s
+      setup_template unless @template
+
+      data = @provided_data.dup
+      data[:code] = @code
+      data[:msg] = @msg
+
+      @template%data
+    end
+
+    def setup_template
+      @template = '%{code}: %{method} -- %{msg}'
+      case @code.to_i
+        when MM_ERROR_METHOD_NOT_FOUND
+          @template += ' (method name between >s: >%{method}<)'
+        when MM_ERROR_REQUIRED_PARAMETER_MISSING
+          @template += @provided_data.inspect
+        when MM_ERROR_INVALID_FROB
+          @template += ' (provided frob between >s: >%{frob}<)'
+        else
+      end
+    end
+  end
+end

data/lib/mind_meister_client/version.rb

@@ -0,0 +1,3 @@
+module MindMeisterClient
+  VERSION = '0.0.1'
+end

data/lib/mind_meister_client.rb

@@ -0,0 +1,164 @@
+require 'json'
+require 'mind_meister_client/version'
+require 'mind_meister_client/request_error'
+require 'mind_meister_client/api_call_required_error'
+
+
+# Before using this client you need to register your app at https://www.mindmeister.com/api -- API Keys
+# For list of all available methods refer to https://www.mindmeister.com/developers/explore
+module MindMeisterClient
+  class Requester
+    MM_API_SCOPES   = %w( auth boundaries connections files folders ideas images maps people realtime reflection tasks
+                          test themes user)
+    SERVER_ADDRESS  = 'www.mindmeister.com'
+
+    attr_accessor :api_key
+    attr_accessor :auth_token
+    attr_accessor :http_client
+
+    def initialize api_key, secret_key, auth_token = nil
+      @api_key = api_key
+      @auth_token = auth_token
+      @secret_key = secret_key
+
+      init_http_client
+    end
+
+    def init_http_client
+      @http_client = Net::HTTP.new SERVER_ADDRESS, 443
+      @http_client.use_ssl = true
+    end
+
+    # Handles callback call after user of MMC acquired frob
+    #
+    # @param [String] frob
+    #
+    # @return [Hash]
+    def callback frob
+      # Calling MM API to get actual auth_token
+      auth_get_token frob: frob
+    end
+
+    # When calling MM API method, it is expected to be underscore separated and without the initial mm_
+    #
+    # @param [Symbol] id Name of method originally called
+    def method_missing id, *args
+      if api_scope? id
+        api_method_name = prepare_api_method id
+        request api_method_name, *args
+      else
+        super
+      end
+    end
+
+    # Detects if method name seems to be from MM API
+    #
+    # @param [Symbol] ruby_method_name
+    #
+    # @return [TrueClass]
+    def api_scope? ruby_method_name
+      ruby_method_scope = ruby_method_name.to_s.split('_')[0]
+
+      ruby_method_scope && MM_API_SCOPES.include?(ruby_method_scope)
+    end
+
+
+    # Makes the actual call to MM API
+    #
+    # @raise [MindMeisterClient::ApiCallRequiredError] When no auth_token has been set up
+    # @raise [MindMeisterClient::RequestError] When MM API returns an error
+    #
+    # @param [String] api_method_name
+    #
+    # @return [Hash]
+    def request api_method_name, *args
+      unless @auth_token || api_method_name =~ /auth/
+        raise_auth_token_request
+      end
+
+      if args[0]
+        api_call_params = args[0].merge(api_default_params)
+      else
+        api_call_params = api_default_params
+      end
+
+      api_call_params[:method] = api_method_name
+
+      api_data = JSON.parse http_client.get('/services/rest?' + signed_query_string(api_call_params)).body,
+                            symbolize_names: true
+
+      if api_data[:rsp][:stat] == 'fail'
+        raise RequestError.new api_data[:rsp][:err][:code].to_i,
+                               api_data[:rsp][:err][:msg],
+                               api_call_params
+      else
+        api_data[:rsp]
+      end
+
+    end
+
+    # @raise [ApiCallRequiredError] Every day'n'night!
+    def raise_auth_token_request
+      api_call_params = {
+        api_key:  @api_key,
+        method:   'mm.auth.getToken',
+        perms:    'read'
+      }
+      raise ApiCallRequiredError.new 'Authentication token missing',
+                                     'https://%s/services/auth/?%s'%[
+                                       SERVER_ADDRESS,
+                                       signed_query_string(api_call_params)
+                                     ]
+    end
+
+    # Bare minimum to send to MM API
+    #
+    # @return [Hash]
+    def api_default_params
+      { api_key: @api_key,
+        auth_token: @auth_token,
+        response_format: 'json'
+      }
+    end
+
+    # maps_new_from_template -> mm.maps.newFromTemplate
+    #
+    # This is helper for method_missing method of this class
+    #
+    # @param [Symbol] ruby_method_name
+    # @return [String]
+    def prepare_api_method ruby_method_name
+      rmn_parts = ruby_method_name.to_s.split('_')
+
+      'mm.%s.%s%s'%[
+        rmn_parts[0],
+        rmn_parts[1],
+        rmn_parts[2..rmn_parts.length].map(&:capitalize).join('')
+      ]
+
+    end
+
+    # From hash, this methods creates query parameters for API call. This method also appends signature, required by
+    #   most of MindMeister API calls.
+    #
+    # More about signing MM API calls at https://www.mindmeister.com/developers/authentication
+    #
+    # @param [Hash] params
+    #
+    # @return [String]
+    def signed_query_string params
+      query_params_joined = params.sort.inject('') { |memo, key|
+        memo += key[0].to_s + key[1].to_s
+        memo
+      }
+
+      signature_data = @secret_key + query_params_joined
+
+      query_string_params = URI.encode_www_form(params)
+
+      signature = Digest::MD5.hexdigest(signature_data)
+
+      query_string_params + '&api_sig=' + signature
+    end
+  end
+end

data/mind_meister_client.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mind_meister_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mind_meister_client'
+  spec.version       = MindMeisterClient::VERSION
+  spec.authors       = ['Mailo Svetel']
+  spec.email         = ['development@rooland.cz']
+  spec.summary       = 'Client for API of web based mind mapping app -- MindMeister'
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = 'https://github.com/roolo/mind_meister_client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',  '~> 1.7'
+  spec.add_development_dependency 'rake',     '~> 10.0'
+  spec.add_development_dependency 'rspec',    '~> 3.3.0'
+end

data/spec/mind_meister_client/requester_spec.rb

@@ -0,0 +1,58 @@
+describe MindMeisterClient::Requester do
+  subject { MindMeisterClient::Requester.new('1625a1388f512a203faa43e8685bcdde', '2d845879a2f2a3b1') }
+
+  describe '#prepare_api_method' do
+    it 'prepares mm.maps.getList' do
+      expect(subject.prepare_api_method(:maps_get_list)).to eq 'mm.maps.getList'
+    end
+
+    it 'prepares mm.auth.getToken' do
+      expect(subject.prepare_api_method(:auth_get_token)).to eq 'mm.auth.getToken'
+    end
+
+    it 'prepares mm.maps.newFromTemplate' do
+      expect(subject.prepare_api_method(:maps_new_from_template)).to eq 'mm.maps.newFromTemplate'
+    end
+  end
+
+
+  describe '#api_scope?' do
+    describe 'MM API scopes' do
+      it 'detects MM API scope for maps_get_list' do
+        expect(subject.api_scope?(:maps_get_list)).to be_truthy
+      end
+
+      it 'detects MM API scope for auth_get_token' do
+        expect(subject.api_scope?(:auth_get_token)).to be_truthy
+      end
+
+      it 'detects MM API scope for maps_new_from_template' do
+        expect(subject.api_scope?(:maps_new_from_template)).to be_truthy
+      end
+    end
+
+    describe 'Ruby methods' do
+      it 'does not detect MM API scope for each_index' do
+        expect(subject.api_scope?(:each_index)).to be_falsey
+      end
+
+      it 'does not detect MM API scope for to_i' do
+        expect(subject.api_scope?(:to_i)).to be_falsey
+      end
+    end
+  end
+
+
+  describe '#signed_query_string' do
+    it 'creates correct query string' do
+      new_params = {
+        x: 4,
+        h: 6,
+        a: 10
+      }
+      signed_query = subject.signed_query_string(new_params)
+
+      expect(signed_query).to eq 'x=4&h=6&a=10&api_sig=3d9576c5e7068213a40354db62f9fbc3'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,103 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'mind_meister_client'
+
+Dir['spec/support/*.rb'].each {|file| load file}
+
+# 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.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# 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
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow 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.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # 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://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  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

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: mind_meister_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mailo Svetel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: 
+email:
+- development@rooland.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mind_meister_client.rb
+- lib/mind_meister_client/api_call_required_error.rb
+- lib/mind_meister_client/request_error.rb
+- lib/mind_meister_client/version.rb
+- mind_meister_client.gemspec
+- spec/mind_meister_client/requester_spec.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep
+homepage: https://github.com/roolo/mind_meister_client
+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.6
+signing_key: 
+specification_version: 4
+summary: Client for API of web based mind mapping app -- MindMeister
+test_files:
+- spec/mind_meister_client/requester_spec.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep