{"id":19900638,"url":"https://github.com/microcmsio/microcms-ruby-sdk","last_synced_at":"2025-05-02T23:31:09.177Z","repository":{"id":38851341,"uuid":"420298559","full_name":"microcmsio/microcms-ruby-sdk","owner":"microcmsio","description":"microCMS Ruby SDK.","archived":false,"fork":false,"pushed_at":"2023-07-18T04:32:04.000Z","size":39,"stargazers_count":8,"open_issues_count":2,"forks_count":3,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-04-28T05:52:27.259Z","etag":null,"topics":["microcms","ruby"],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/microcms-ruby-sdk","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microcmsio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-10-23T02:56:33.000Z","updated_at":"2023-11-18T06:26:58.000Z","dependencies_parsed_at":"2023-01-23T15:50:19.715Z","dependency_job_id":null,"html_url":"https://github.com/microcmsio/microcms-ruby-sdk","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microcmsio%2Fmicrocms-ruby-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microcmsio%2Fmicrocms-ruby-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microcmsio%2Fmicrocms-ruby-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microcmsio%2Fmicrocms-ruby-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microcmsio","download_url":"https://codeload.github.com/microcmsio/microcms-ruby-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224341452,"owners_count":17295271,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["microcms","ruby"],"created_at":"2024-11-12T20:12:50.430Z","updated_at":"2024-11-12T20:12:50.522Z","avatar_url":"https://github.com/microcmsio.png","language":"Ruby","readme":"# microCMS Ruby SDK\n\n[microCMS](https://document.microcms.io/manual/api-request) Ruby SDK.\n\n## Tutorial\n\nSee [official tutorial](https://document.microcms.io/tutorial/ruby/ruby-top).\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'microcms-ruby-sdk'\n```\n\nAnd then execute:\n\n    $ bundle install\n\nOr install it yourself as:\n\n    $ gem install microcms-ruby-sdk\n\n## Usage\n\n### Import\n\n```rb\nrequire 'microcms'\n```\n\n### Create client object\n\n```rb\nMicroCMS.service_domain = 'YOUR_DOMAIN'\nMicroCMS.api_key = 'YOUR_API_KEY'\n```\n\nNote that the `YOUR_DOMAIN` is the subdomain name of your service (not the FQDN).\n\n### Get content list\n\n```rb\nputs MicroCMS.list('endpoint')\n```\n\n### Get content list with parameters\n\n```rb\nputs MicroCMS.list(\n    'endpoint',\n    {\n        draft_key: \"abcd\",\n        limit: 100,\n        offset: 1,\n        orders: ['updatedAt'],\n        q: 'Hello',\n        fields: %w[id title],\n        ids: ['foo'],\n        filters: 'publishedAt[greater_than]2021-01-01',\n        depth: 1,\n    },\n)\n```\n\n### Get single content\n\n```rb\nputs MicroCMS.get('endpoint', 'ruby')\n```\n\n### Get single content with parameters\n\n```rb\nputs MicroCMS.get(\n    'endpoint',\n    'ruby',\n    {\n        draft_key: 'abcdef1234',\n        fields: %w[title publishedAt],\n        depth: 1,\n    },\n)\n```\n\n### Get object form content\n\n```rb\nputs MicroCMS.get('endpoint')\n```\n\n### Create content\n\n```rb\nputs MicroCMS.create('endpoint', { text: 'Hello, microcms-ruby-sdk!' })\n```\n\n### Create content with specified ID\n\n```rb\nputs MicroCMS.create(\n    'endpoint',\n    {\n        id: 'my-content-id',\n        text: 'Hello, microcms-ruby-sdk!',\n    },\n)\n```\n\n### Create draft content\n\n```rb\nputs MicroCMS.create(\n    'endpoint',\n    {\n        id: 'my-content-id',\n        text: 'Hello, microcms-ruby-sdk!',\n    },\n    { status: 'draft' },\n)\n```\n\n### Update content\n\n```rb\n\nputs MicroCMS.update(\n    'endpoint',\n    {\n        id: 'microcms-ruby-sdk',\n        text: 'Hello, microcms-ruby-sdk update method!',\n    },\n)\n```\n\n### Update object form content\n\n```rb\nputs MicroCMS.update('endpoint', { text: 'Hello, microcms-ruby-sdk update method!' })\n```\n\n### Delete content\n\n```rb\nMicroCMS.delete('endpoint', 'microcms-ruby-sdk')\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at \u003chttps://github.com/microcmsio/microcms-ruby-sdk\u003e.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrocmsio%2Fmicrocms-ruby-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrocmsio%2Fmicrocms-ruby-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrocmsio%2Fmicrocms-ruby-sdk/lists"}