How to get the specified expose

Open
#323 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
ruby
Domain
api

Research direction

The issue shows User's expose declarations and the Entity::User.represent_only call; start by checking how represent_only handles the listed symbols and options hash. Document the correct selection syntax and the expected JSON result, including conditional exposes.

Written by the indexing model from the issue text.

Description

User Entity

  class User < EEntity
    expose :id, :name, :pinyin, :account_id, :hidden, :dept_id, :actived
    expose :initialism, as: :short_pinyin
    expose :role_code
    expose :login_name
    expose(:email, if: lambda { |u, op| op[:included_user_email] == true }) do |u, options|
      u.email
    end
    expose :cellvoice1, if: lambda { |u, op| !op[:no_privacy] } do |u, options|
      if u.get_user_info
        u.get_user_info.cellvoice1
      else
        nil
      end
    end
    expose :nickname do |u, options|
      if u.get_user_info
        u.get_user_info.nickname
      else
        nil
      end
    end
    expose :workvoice do |u, options|
      if u.get_user_info
        u.get_user_info.workvoice
      else
        nil
      end
    end
    expose :dept_name do |u, options|
      uinfo = u.get_user_info
      if uinfo
        uinfo.get_dept_display_name
      else
        nil
      end
    end
end

How to get some of these exposes?
example:

::Entity::User.represent_only([:name.:pinyin, :account_id, :hidden, :dept_id ],{}).as_json

Result:

{
  name: 'xxx',
  pinyin: 'xxx',
  account_id: 1,
  hidden: true,
  dept_id: 2
}
Dominant language
Ruby
Stars
729
Forks
154
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ruby-grape/grape-entity

All issues in ruby-grape/grape-entity

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.